Module `spin_sdk.wit.imports.spin_sqlite_sqlite`

Global variables

var Error: The set of errors which may be raised by functions in this interface
var Value: A single column's result from a database query

Classes

class Connection

Expand source code

class Connection:
    """
    A handle to an open sqlite instance
    """
    
    @classmethod
    def open(cls, database: str) -> Self:
        """
        Open a connection to a named database instance.
        
        If `database` is "default", the default instance is opened.
        
        `error::no-such-database` will be raised if the `name` is not recognized.
        
        Raises: `spin_sdk.wit.types.Err(spin_sdk.wit.imports.spin_sqlite_sqlite.Error)`
        """
        raise NotImplementedError
    def execute(self, statement: str, parameters: List[Value]) -> QueryResult:
        """
        Execute a statement returning back data if there is any
        
        Raises: `spin_sdk.wit.types.Err(spin_sdk.wit.imports.spin_sqlite_sqlite.Error)`
        """
        raise NotImplementedError
    def last_insert_rowid(self) -> int:
        """
        The SQLite rowid of the most recent successful INSERT on the connection, or 0 if
        there has not yet been an INSERT on the connection.
        """
        raise NotImplementedError
    def changes(self) -> int:
        """
        The number of rows modified, inserted or deleted by the most recently completed
        INSERT, UPDATE or DELETE statement on the connection.
        """
        raise NotImplementedError
    def __enter__(self) -> Self:
        """Returns self"""
        return self
                                
    def __exit__(self, exc_type: type[BaseException] | None, exc_value: BaseException | None, traceback: TracebackType | None) -> bool | None:
        """
        Release this resource.
        """
        raise NotImplementedError

A handle to an open sqlite instance

Static methods

def open(database: str) ‑> Self: Open a connection to a named database instance.

If database is "default", the default instance is opened.

error::no-such-database will be raised if the name is not recognized.

Raises: Err(Error)

Methods

def changes(self) ‑> int

Expand source code

def changes(self) -> int:
    """
    The number of rows modified, inserted or deleted by the most recently completed
    INSERT, UPDATE or DELETE statement on the connection.
    """
    raise NotImplementedError

The number of rows modified, inserted or deleted by the most recently completed INSERT, UPDATE or DELETE statement on the connection.

def execute(self, statement: str, parameters: List[Value_Integer | Value_Real | Value_Text | Value_Blob | Value_Null]) ‑> QueryResult

Expand source code

def execute(self, statement: str, parameters: List[Value]) -> QueryResult:
    """
    Execute a statement returning back data if there is any
    
    Raises: `spin_sdk.wit.types.Err(spin_sdk.wit.imports.spin_sqlite_sqlite.Error)`
    """
    raise NotImplementedError

Execute a statement returning back data if there is any

Raises: Err(Error)

def last_insert_rowid(self) ‑> int

Expand source code

def last_insert_rowid(self) -> int:
    """
    The SQLite rowid of the most recent successful INSERT on the connection, or 0 if
    there has not yet been an INSERT on the connection.
    """
    raise NotImplementedError

The SQLite rowid of the most recent successful INSERT on the connection, or 0 if there has not yet been an INSERT on the connection.

class Error_AccessDenied

Expand source code

@dataclass
class Error_AccessDenied:
    pass

Error_AccessDenied()

class Error_DatabaseFull

Expand source code

@dataclass
class Error_DatabaseFull:
    pass

Error_DatabaseFull()

class Error_InvalidConnection

Expand source code

@dataclass
class Error_InvalidConnection:
    pass

Error_InvalidConnection()

class Error_Io (value: str)

Expand source code

@dataclass
class Error_Io:
    value: str

Error_Io(value: str)

Instance variables

var value : str

class Error_NoSuchDatabase

Expand source code

@dataclass
class Error_NoSuchDatabase:
    pass

Error_NoSuchDatabase()

class QueryResult (columns: List[str], rows: List[RowResult])

Expand source code

@dataclass
class QueryResult:
    """
    A result of a query
    """
    columns: List[str]
    rows: List[RowResult]

A result of a query

Instance variables

var columns : List[str]
var rows : List[RowResult]

class RowResult (values: List[Value_Integer | Value_Real | Value_Text | Value_Blob | Value_Null])

Expand source code

@dataclass
class RowResult:
    """
    A set of values for each of the columns in a query-result
    """
    values: List[Value]

A set of values for each of the columns in a query-result

Instance variables

var values : List[Value_Integer | Value_Real | Value_Text | Value_Blob | Value_Null]

class Value_Blob (value: bytes)

Expand source code

@dataclass
class Value_Blob:
    value: bytes

Value_Blob(value: bytes)

Instance variables

var value : bytes

class Value_Integer (value: int)

Expand source code

@dataclass
class Value_Integer:
    value: int

Value_Integer(value: int)

Instance variables

var value : int

class Value_Null

Expand source code

@dataclass
class Value_Null:
    pass

Value_Null()

class Value_Real (value: float)

Expand source code

@dataclass
class Value_Real:
    value: float

Value_Real(value: float)

Instance variables

var value : float

class Value_Text (value: str)

Expand source code

@dataclass
class Value_Text:
    value: str

Value_Text(value: str)

Instance variables

var value : str