aws_redshift

AWS Redshift connection configuration.

class mcp_ohmy_sql.config.aws_redshift.AwsRedshiftConnectionMethodEnum(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]

Supported connection methods for AWS Redshift.

class mcp_ohmy_sql.config.aws_redshift.AWSRedshiftConnection(*, type: Literal['aws_redshift'] = 'aws_redshift', method: str, host: str | None = None, port: int | None = None, database: str | None = None, username: str | None = None, password: str | None = None, cluster_identifier: str | None = None, namespace_name: str | None = None, workgroup_name: str | None = None, boto_session_kwargs: BotoSessionKwargs | None = None, redshift_connector_kwargs: dict[str, Any] | None = None)[source]

Configures AWS Redshift connections for data warehouse access.

Provides multiple connection methods for different Redshift deployment types:

Parameters:

  • type – DO NOT set this field manually, it is automatically set to “aws_redshift”.

  • method – Connection library to use - “redshift_connector” or “sqlalchemy”

Direct Connection Parameters (username/password authentication):

Parameters:

  • host – Redshift cluster endpoint hostname

  • port – Redshift cluster port (usually 5439)

  • database – Target database name

  • username – Database username

  • password – Database password

IAM-based Authentication for Redshift Cluster:

Parameters:

  • cluster_identifier – Redshift cluster identifier for IAM authentication

  • database – Target database name

  • boto_session_kwargs – AWS credentials and session configuration

IAM-based Authentication for Redshift Serverless:

Parameters:

  • namespace_name – Redshift Serverless namespace name

  • workgroup_name – Redshift Serverless workgroup name

  • boto_session_kwargs – AWS credentials and session configuration

Additional Configuration:

Parameters:

redshift_connector_kwargs – Additional parameters for the redshift-connector library

get_rs_conn() → redshift_connector.Connection[source]

Returns a Redshift connection object using the redshift_connector library.

property rs_conn: redshift_connector.Connection

Returns a cached Redshift connection object using the redshift_connector library.

get_sa_engine() → Engine[source]

Returns a SQLAlchemy engine for connecting to AWS Redshift.

property sa_engine: Engine

Returns a cached SQLAlchemy engine for connecting to AWS Redshift.

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].