Module spin_sdk.wit.imports.spin_postgres_postgres

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 postgres database.
    """
    
    @classmethod
    def open(cls, address: str) -> Self:
        """
        Open a connection to the Postgres instance at `address`.
        
        Raises: `spin_sdk.wit.types.Err(spin_sdk.wit.imports.spin_postgres_postgres.Error)`
        """
        raise NotImplementedError
    def query(self, statement: str, params: List[ParameterValue]) -> RowSet:
        """
        Query the database.
        
        Raises: `spin_sdk.wit.types.Err(spin_sdk.wit.imports.spin_postgres_postgres.Error)`
        """
        raise NotImplementedError
    def execute(self, statement: str, params: List[ParameterValue]) -> int:
        """
        Execute command to the database.
        
        Raises: `spin_sdk.wit.types.Err(spin_sdk.wit.imports.spin_postgres_postgres.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 postgres database.

Static methods

def open(address: str) ‑> Self

Open a connection to the Postgres instance at address.

Raises: Err(Error)

Methods

def execute(self,
statement: str,
params: List[ParameterValue_Boolean | ParameterValue_Int8 | ParameterValue_Int16 | ParameterValue_Int32 | ParameterValue_Int64 | ParameterValue_Floating32 | ParameterValue_Floating64 | ParameterValue_Str | ParameterValue_Binary | ParameterValue_Date | ParameterValue_Time | ParameterValue_Datetime | ParameterValue_Timestamp | ParameterValue_DbNull]) ‑> int
Expand source code 
def execute(self, statement: str, params: List[ParameterValue]) -> int:
    """
    Execute command to the database.
    
    Raises: `spin_sdk.wit.types.Err(spin_sdk.wit.imports.spin_postgres_postgres.Error)`
    """
    raise NotImplementedError

Execute command to the database.

Raises: Err(Error)

def query(self,
statement: str,
params: List[ParameterValue_Boolean | ParameterValue_Int8 | ParameterValue_Int16 | ParameterValue_Int32 | ParameterValue_Int64 | ParameterValue_Floating32 | ParameterValue_Floating64 | ParameterValue_Str | ParameterValue_Binary | ParameterValue_Date | ParameterValue_Time | ParameterValue_Datetime | ParameterValue_Timestamp | ParameterValue_DbNull]) ‑> RowSet
Expand source code 
def query(self, statement: str, params: List[ParameterValue]) -> RowSet:
    """
    Query the database.
    
    Raises: `spin_sdk.wit.types.Err(spin_sdk.wit.imports.spin_postgres_postgres.Error)`
    """
    raise NotImplementedError

Query the database.

Raises: 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
    FLOATING32 = 5
    FLOATING64 = 6
    STR = 7
    BINARY = 8
    DATE = 9
    TIME = 10
    DATETIME = 11
    TIMESTAMP = 12
    OTHER = 13

Data types for a database column

Ancestors

  • enum.Enum

Class variables

var BINARY
var BOOLEAN
var DATE
var DATETIME
var FLOATING32
var FLOATING64
var INT16
var INT32
var INT64
var INT8
var OTHER
var STR
var TIME
var TIMESTAMP
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_Date (value: Tuple[int, int, int])
Expand source code 
@dataclass
class DbValue_Date:
    value: Tuple[int, int, int]

DbValue_Date(value: Tuple[int, int, int])

Instance variables

var value : Tuple[int, int, int]
class DbValue_Datetime (value: Tuple[int, int, int, int, int, int, int])
Expand source code 
@dataclass
class DbValue_Datetime:
    value: Tuple[int, int, int, int, int, int, int]

DbValue_Datetime(value: Tuple[int, int, int, int, int, int, int])

Instance variables

var value : Tuple[int, int, int, int, int, int, int]
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_Time (value: Tuple[int, int, int, int])
Expand source code 
@dataclass
class DbValue_Time:
    value: Tuple[int, int, int, int]

DbValue_Time(value: Tuple[int, int, int, int])

Instance variables

var value : Tuple[int, int, int, int]
class DbValue_Timestamp (value: int)
Expand source code 
@dataclass
class DbValue_Timestamp:
    value: int

DbValue_Timestamp(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_Date (value: Tuple[int, int, int])
Expand source code 
@dataclass
class ParameterValue_Date:
    value: Tuple[int, int, int]

ParameterValue_Date(value: Tuple[int, int, int])

Instance variables

var value : Tuple[int, int, int]
class ParameterValue_Datetime (value: Tuple[int, int, int, int, int, int, int])
Expand source code 
@dataclass
class ParameterValue_Datetime:
    value: Tuple[int, int, int, int, int, int, int]

ParameterValue_Datetime(value: Tuple[int, int, int, int, int, int, int])

Instance variables

var value : Tuple[int, int, int, int, int, int, int]
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_Time (value: Tuple[int, int, int, int])
Expand source code 
@dataclass
class ParameterValue_Time:
    value: Tuple[int, int, int, int]

ParameterValue_Time(value: Tuple[int, int, int, int])

Instance variables

var value : Tuple[int, int, int, int]
class ParameterValue_Timestamp (value: int)
Expand source code 
@dataclass
class ParameterValue_Timestamp:
    value: int

ParameterValue_Timestamp(value: int)

Instance variables

var value : int
class RowSet (columns: List[Column],
rows: List[List[DbValue_Boolean | DbValue_Int8 | DbValue_Int16 | DbValue_Int32 | DbValue_Int64 | DbValue_Floating32 | DbValue_Floating64 | DbValue_Str | DbValue_Binary | DbValue_Date | DbValue_Time | DbValue_Datetime | DbValue_Timestamp | DbValue_DbNull | DbValue_Unsupported]])
Expand source code 
@dataclass
class RowSet:
    """
    A set of database rows
    """
    columns: List[Column]
    rows: List[List[DbValue]]

A set of database rows

Instance variables

var columns : List[Column]
var rows : List[List[DbValue_Boolean | DbValue_Int8 | DbValue_Int16 | DbValue_Int32 | DbValue_Int64 | DbValue_Floating32 | DbValue_Floating64 | DbValue_Str | DbValue_Binary | DbValue_Date | DbValue_Time | DbValue_Datetime | DbValue_Timestamp | DbValue_DbNull | DbValue_Unsupported]]