ORIONIS API REFERENCE

THE ORIONIS API

Build with clarity.

Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.

class documentation

Configure Amazon Redshift with the official AWS Python connector.

Method __post_init__ Validate connector settings without contacting AWS or opening a socket.
Instance Variable cluster_identifier Provisioned cluster identifier for IAM authentication.
Instance Variable database Database name.
Instance Variable db_user Database user requested through IAM.
Instance Variable driver Fixed Redshift driver identifier.
Instance Variable host Cluster endpoint, or None when IAM resolves the endpoint.
Instance Variable iam Enable the connector's IAM authentication.
Instance Variable is_serverless Select Redshift Serverless instead of a provisioned cluster.
Instance Variable password Database authentication password, unused with IAM credentials.
Instance Variable port Database port, defaulting to 5439.
Instance Variable prefix Table name prefix.
Instance Variable profile AWS credentials profile; None uses the SDK credential chain.
Instance Variable region AWS region used for IAM endpoint and credential resolution.
Instance Variable serverless_acct_id AWS account owning the Serverless workgroup.
Instance Variable serverless_work_group Serverless workgroup used for endpoint resolution.
Instance Variable ssl Enable TLS for database connections.
Instance Variable sslmode Certificate verification policy, defaulting to verify-full.
Instance Variable timeout Connection socket timeout in seconds, or None for no timeout.
Instance Variable username Database authentication user.

Inherited from BaseEntity:

Class Method _cachedFieldMetadata Retrieve field definitions and normalized types cached by class.
Method __init__ Initialize declared fields and public extra attributes.
Method _dynamicAttributes Return public instance attributes that are not declared fields.
Method _validateExtraNames Validate names and storage for public extra attributes.
Method getFields Describe declared fields and, optionally, dynamic attributes.
Method toDict Return a recursively copied dictionary of declared and extra values.
Class Variable __slots__ Declare that this class introduces no additional instance slots.
Class Variable _orionis_field_metadata Cache declared fields and normalized type names for each concrete class.
def __post_init__(self): (source)

Validate connector settings without contacting AWS or opening a socket.

Returns
NoneValidate scalar fields and store the canonical SSL mode.
Raises
TypeErrorIf a setting has an incompatible type.
ValueErrorIf the driver, port, timeout or SSL mode is invalid.
cluster_identifier: str | None = (source)

Provisioned cluster identifier for IAM authentication.

database: str = (source)

Database name.

db_user: str | None = (source)

Database user requested through IAM.

Fixed Redshift driver identifier.

host: str | None = (source)

Cluster endpoint, or None when IAM resolves the endpoint.

Enable the connector's IAM authentication.

is_serverless: bool = (source)

Select Redshift Serverless instead of a provisioned cluster.

password: str | None = (source)

Database authentication password, unused with IAM credentials.

port: str | int = (source)

Database port, defaulting to 5439.

Table name prefix.

profile: str | None = (source)

AWS credentials profile; None uses the SDK credential chain.

region: str | None = (source)

AWS region used for IAM endpoint and credential resolution.

serverless_acct_id: str | None = (source)

AWS account owning the Serverless workgroup.

serverless_work_group: str | None = (source)

Serverless workgroup used for endpoint resolution.

Enable TLS for database connections.

sslmode: str | orionis.foundation.config.database.RedshiftSSLMode = (source)

Certificate verification policy, defaulting to verify-full.

timeout: int | None = (source)

Connection socket timeout in seconds, or None for no timeout.

username: str | None = (source)

Database authentication user.