Module spin_sdk.wit.imports.spin_mysql_mysql_3_0_0

Global variables

var DbValue

Database values

var Error

Errors related to interacting with a database.

var ParameterValue

Values used in parameterized queries

Classes

class Column (name: str,
data_type: DbDataType)
Expand source code 
@dataclass
class Column:
    """
    A database column
    """
    name: str
    data_type: DbDataType

A database column

Instance variables

var data_type : DbDataType
var name : str
class Connection
Expand source code 
class Connection:
    """
    A connection to a MySQL database.
    """
    
    @classmethod
    async def open(cls, address: str) -> Self:
        """
        Open a connection to the MySQL instance at `address`.
        
        Raises: `componentize_py_types.Err(spin_sdk.wit.imports.spin_mysql_mysql_3_0_0.Error)`
        """
        raise NotImplementedError
    async def query(self, statement: str, params: List[ParameterValue]) -> Tuple[List[Column], StreamReader[List[DbValue]], FutureReader[Result[None, Error]]]:
        """
        query the database: select
        
        Raises: `componentize_py_types.Err(spin_sdk.wit.imports.spin_mysql_mysql_3_0_0.Error)`
        """
        raise NotImplementedError
    async def execute(self, statement: str, params: List[ParameterValue]) -> None:
        """
        execute command to the database: insert, update, delete
        
        Raises: `componentize_py_types.Err(spin_sdk.wit.imports.spin_mysql_mysql_3_0_0.Error)`
        """
        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 connection to a MySQL database.

Static methods

async def open(address: str) ‑> Self

Open a connection to the MySQL instance at address.

Raises: componentize_py_types.Err(Error)

Methods

async def execute(self,
statement: str,
params: List[ParameterValue_Boolean | ParameterValue_Int8 | ParameterValue_Int16 | ParameterValue_Int32 | ParameterValue_Int64 | ParameterValue_Uint8 | ParameterValue_Uint16 | ParameterValue_Uint32 | ParameterValue_Uint64 | ParameterValue_Floating32 | ParameterValue_Floating64 | ParameterValue_Str | ParameterValue_Binary | ParameterValue_DbNull]) ‑> None
Expand source code 
async def execute(self, statement: str, params: List[ParameterValue]) -> None:
    """
    execute command to the database: insert, update, delete
    
    Raises: `componentize_py_types.Err(spin_sdk.wit.imports.spin_mysql_mysql_3_0_0.Error)`
    """
    raise NotImplementedError

execute command to the database: insert, update, delete

Raises: componentize_py_types.Err(Error)

async def query(self,
statement: str,
params: List[ParameterValue_Boolean | ParameterValue_Int8 | ParameterValue_Int16 | ParameterValue_Int32 | ParameterValue_Int64 | ParameterValue_Uint8 | ParameterValue_Uint16 | ParameterValue_Uint32 | ParameterValue_Uint64 | ParameterValue_Floating32 | ParameterValue_Floating64 | ParameterValue_Str | ParameterValue_Binary | ParameterValue_DbNull]) ‑> Tuple[List[Column], componentize_py_async_support.streams.StreamReader[List[DbValue_Boolean | DbValue_Int8 | DbValue_Int16 | DbValue_Int32 | DbValue_Int64 | DbValue_Uint8 | DbValue_Uint16 | DbValue_Uint32 | DbValue_Uint64 | DbValue_Floating32 | DbValue_Floating64 | DbValue_Str | DbValue_Binary | DbValue_DbNull | DbValue_Unsupported]], componentize_py_async_support.futures.FutureReader[componentize_py_types.Ok[None] | componentize_py_types.Err[Error_ConnectionFailed | Error_BadParameter | Error_QueryFailed | Error_ValueConversionFailed | Error_Other]]]
Expand source code 
async def query(self, statement: str, params: List[ParameterValue]) -> Tuple[List[Column], StreamReader[List[DbValue]], FutureReader[Result[None, Error]]]:
    """
    query the database: select
    
    Raises: `componentize_py_types.Err(spin_sdk.wit.imports.spin_mysql_mysql_3_0_0.Error)`
    """
    raise NotImplementedError

query the database: select

Raises: componentize_py_types.Err(Error)

class DbDataType (*args, **kwds)
Expand source code 
class DbDataType(Enum):
    """
    Data types for a database column
    """
    BOOLEAN = 0
    INT8 = 1
    INT16 = 2
    INT32 = 3
    INT64 = 4
    UINT8 = 5
    UINT16 = 6
    UINT32 = 7
    UINT64 = 8
    FLOATING32 = 9
    FLOATING64 = 10
    STR = 11
    BINARY = 12
    OTHER = 13

Data types for a database column

Ancestors

  • enum.Enum

Class variables

var BINARY
var BOOLEAN
var FLOATING32
var FLOATING64
var INT16
var INT32
var INT64
var INT8
var OTHER
var STR
var UINT16
var UINT32
var UINT64
var UINT8
class DbValue_Binary (value: bytes)
Expand source code 
@dataclass
class DbValue_Binary:
    value: bytes

DbValue_Binary(value: bytes)

Instance variables

var value : bytes
class DbValue_Boolean (value: bool)
Expand source code 
@dataclass
class DbValue_Boolean:
    value: bool

DbValue_Boolean(value: bool)

Instance variables

var value : bool
class DbValue_DbNull
Expand source code 
@dataclass
class DbValue_DbNull:
    pass

DbValue_DbNull()

class DbValue_Floating32 (value: float)
Expand source code 
@dataclass
class DbValue_Floating32:
    value: float

DbValue_Floating32(value: float)

Instance variables

var value : float
class DbValue_Floating64 (value: float)
Expand source code 
@dataclass
class DbValue_Floating64:
    value: float

DbValue_Floating64(value: float)

Instance variables

var value : float
class DbValue_Int16 (value: int)
Expand source code 
@dataclass
class DbValue_Int16:
    value: int

DbValue_Int16(value: int)

Instance variables

var value : int
class DbValue_Int32 (value: int)
Expand source code 
@dataclass
class DbValue_Int32:
    value: int

DbValue_Int32(value: int)

Instance variables

var value : int
class DbValue_Int64 (value: int)
Expand source code 
@dataclass
class DbValue_Int64:
    value: int

DbValue_Int64(value: int)

Instance variables

var value : int
class DbValue_Int8 (value: int)
Expand source code 
@dataclass
class DbValue_Int8:
    value: int

DbValue_Int8(value: int)

Instance variables

var value : int
class DbValue_Str (value: str)
Expand source code 
@dataclass
class DbValue_Str:
    value: str

DbValue_Str(value: str)

Instance variables

var value : str
class DbValue_Uint16 (value: int)
Expand source code 
@dataclass
class DbValue_Uint16:
    value: int

DbValue_Uint16(value: int)

Instance variables

var value : int
class DbValue_Uint32 (value: int)
Expand source code 
@dataclass
class DbValue_Uint32:
    value: int

DbValue_Uint32(value: int)

Instance variables

var value : int
class DbValue_Uint64 (value: int)
Expand source code 
@dataclass
class DbValue_Uint64:
    value: int

DbValue_Uint64(value: int)

Instance variables

var value : int
class DbValue_Uint8 (value: int)
Expand source code 
@dataclass
class DbValue_Uint8:
    value: int

DbValue_Uint8(value: int)

Instance variables

var value : int
class DbValue_Unsupported
Expand source code 
@dataclass
class DbValue_Unsupported:
    pass

DbValue_Unsupported()

class Error_BadParameter (value: str)
Expand source code 
@dataclass
class Error_BadParameter:
    value: str

Error_BadParameter(value: str)

Instance variables

var value : str
class Error_ConnectionFailed (value: str)
Expand source code 
@dataclass
class Error_ConnectionFailed:
    value: str

Error_ConnectionFailed(value: str)

Instance variables

var value : str
class Error_Other (value: str)
Expand source code 
@dataclass
class Error_Other:
    value: str

Error_Other(value: str)

Instance variables

var value : str
class Error_QueryFailed (value: str)
Expand source code 
@dataclass
class Error_QueryFailed:
    value: str

Error_QueryFailed(value: str)

Instance variables

var value : str
class Error_ValueConversionFailed (value: str)
Expand source code 
@dataclass
class Error_ValueConversionFailed:
    value: str

Error_ValueConversionFailed(value: str)

Instance variables

var value : str
class ParameterValue_Binary (value: bytes)
Expand source code 
@dataclass
class ParameterValue_Binary:
    value: bytes

ParameterValue_Binary(value: bytes)

Instance variables

var value : bytes
class ParameterValue_Boolean (value: bool)
Expand source code 
@dataclass
class ParameterValue_Boolean:
    value: bool

ParameterValue_Boolean(value: bool)

Instance variables

var value : bool
class ParameterValue_DbNull
Expand source code 
@dataclass
class ParameterValue_DbNull:
    pass

ParameterValue_DbNull()

class ParameterValue_Floating32 (value: float)
Expand source code 
@dataclass
class ParameterValue_Floating32:
    value: float

ParameterValue_Floating32(value: float)

Instance variables

var value : float
class ParameterValue_Floating64 (value: float)
Expand source code 
@dataclass
class ParameterValue_Floating64:
    value: float

ParameterValue_Floating64(value: float)

Instance variables

var value : float
class ParameterValue_Int16 (value: int)
Expand source code 
@dataclass
class ParameterValue_Int16:
    value: int

ParameterValue_Int16(value: int)

Instance variables

var value : int
class ParameterValue_Int32 (value: int)
Expand source code 
@dataclass
class ParameterValue_Int32:
    value: int

ParameterValue_Int32(value: int)

Instance variables

var value : int
class ParameterValue_Int64 (value: int)
Expand source code 
@dataclass
class ParameterValue_Int64:
    value: int

ParameterValue_Int64(value: int)

Instance variables

var value : int
class ParameterValue_Int8 (value: int)
Expand source code 
@dataclass
class ParameterValue_Int8:
    value: int

ParameterValue_Int8(value: int)

Instance variables

var value : int
class ParameterValue_Str (value: str)
Expand source code 
@dataclass
class ParameterValue_Str:
    value: str

ParameterValue_Str(value: str)

Instance variables

var value : str
class ParameterValue_Uint16 (value: int)
Expand source code 
@dataclass
class ParameterValue_Uint16:
    value: int

ParameterValue_Uint16(value: int)

Instance variables

var value : int
class ParameterValue_Uint32 (value: int)
Expand source code 
@dataclass
class ParameterValue_Uint32:
    value: int

ParameterValue_Uint32(value: int)

Instance variables

var value : int
class ParameterValue_Uint64 (value: int)
Expand source code 
@dataclass
class ParameterValue_Uint64:
    value: int

ParameterValue_Uint64(value: int)

Instance variables

var value : int
class ParameterValue_Uint8 (value: int)
Expand source code 
@dataclass
class ParameterValue_Uint8:
    value: int

ParameterValue_Uint8(value: int)

Instance variables

var value : int