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 |
Validate connector settings without contacting AWS or opening a socket. |
| Instance Variable | cluster |
Provisioned cluster identifier for IAM authentication. |
| Instance Variable | database |
Database name. |
| Instance Variable | db |
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 |
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 |
AWS account owning the Serverless workgroup. |
| Instance Variable | serverless |
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 | _cached |
Retrieve field definitions and normalized types cached by class. |
| Method | __init__ |
Initialize declared fields and public extra attributes. |
| Method | _dynamic |
Return public instance attributes that are not declared fields. |
| Method | _validate |
Validate names and storage for public extra attributes. |
| Method | get |
Describe declared fields and, optionally, dynamic attributes. |
| Method | to |
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 |
Cache declared fields and normalized type names for each concrete class. |
Validate connector settings without contacting AWS or opening a socket.
| Returns | |
None | Validate scalar fields and store the canonical SSL mode. |
| Raises | |
TypeError | If a setting has an incompatible type. |
ValueError | If the driver, port, timeout or SSL mode is invalid. |