SAMSqlConnection

SAM model of the SqlConnection kind, generated from the Smarter platform’s JSON Schema.

Do not edit: run scripts/generate_sam_models.py. See smarter.models.sam.

class smarter.models.sam.sqlconnection.Connection(*, authenticationMethod: str | None = 'none', database: str, dbEngine: str, hostname: str, maxOverflow: int | None = 10, password: str | None = None, poolSize: int | None = 5, port: int | None = None, proxyHost: str | None = None, proxyPassword: str | None = None, proxyPort: int | None = None, proxyUsername: str | None = None, sshKnownHosts: str | None = None, sslCa: str | None = None, sslCert: str | None = None, sslKey: str | None = None, timeout: int | None = 30, useSsl: bool | None = False, username: str | None = None, **extra_data: Any)

Bases: SAMModel

Smarter API - generic SQL Connection class.

authenticationMethod: str | None

The authentication method to use for the connection.

Example: ‘Standard TCP/IP’, ‘Standard TCP/IP over SSH’, ‘LDAP User/Password’.

database: str

The name of the database to connect to.

Examples: ‘sales’ or ‘mydb’.

dbEngine: str

A valid SQL database engine. Common db_engines: [‘django.db.backends.postgresql’, ‘django.db.backends.mysql’, ‘django.db.backends.oracle’, ‘django.db.backends.sqlite3’, ‘django.db.backends.mssql’, ‘django.db.backends.sybase’].

hostname: str

The remote host of the SQL connection.

Should be a valid internet domain name. Example: ‘localhost’ or ‘mysql.mycompany.com’.

maxOverflow: int | None

The maximum number of connections to allow beyond the pool size.

password: str | None

The password.

poolSize: int | None

The size of the connection pool.

port: int | None

The port of the SQL connection.

Default values are assigned based on the dbEngine.

proxyHost: str | None

The remote host of the SQL proxy connection.

Should be a valid internet domain name.

proxyPassword: str | None

The password for the proxy connection.

proxyPort: int | None

The port of the SQL proxy connection.

proxyUsername: str | None

The username for the proxy connection.

sshKnownHosts: str | None

The known_hosts file content for verifying SSH connections.

sslCa: str | None

The Certificate Authority (CA) certificate for verifying the server.

sslCert: str | None

The SSL certificate for the connection, if required.

sslKey: str | None

The SSL key for the connection, if required.

timeout: int | None

The timeout for the database connection in seconds.

Default is 30 seconds.

useSsl: bool | None

Whether to use SSL/TLS for the connection.

username: str | None

The database username.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

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

class smarter.models.sam.sqlconnection.SAMConnectionCommonMetadata(*, annotations: None | list[dict[str, str | int | float | bool | date | datetime | UUID | bytes | list | dict[str, Any]]] = None, description: str | None, name: str, tags: list[str] | None = None, version: str | None, **extra_data: Any)

Bases: SAMModel

Smarter API Connection Manifest - common Metadata class.

annotations: None | list[dict[str, str | int | float | bool | date | datetime | UUID | bytes | list | dict[str, Any]]]

The manifest annotations.

Used for storing arbitrary metadata as

key-value pairs. Example: [{‘smarter.sh/test-manifest/project-name’: ‘Scooby dooby do’}]. The key should be a valid url-friendly string. The value accepts multi-line string values (YAML block scalars) and various scalar types including str, int, float, bool, datetime.date, datetime.datetime, decimal.Decimal, uuid.UUID, bytes, list, dict.

description: str | None

The description for this resource.

Be brief. Keep it under 255 characters.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

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

name: str

The camelCase name of the manifest resource.

tags: list[str] | None

The tags of the manifest.

Used for generic resource categorization and search. Example: [‘tag1’, ‘tag2’]

version: str | None

The semantic version of the manifest.

Example: 0.1.0

class smarter.models.sam.sqlconnection.SAMDependency(*, kind: str, name: str, **extra_data: Any)

Bases: SAMModel

A resource that depends on the resource that a manifest describes.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

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

kind: str

Kind[String]: The SAM kind of the resource that depends on this resource, e.g. LLMClient.

Read only.

name: str

Name[String]: The name of the resource that depends on this resource.

Read only.

class smarter.models.sam.sqlconnection.SAMSqlConnectionSpec(*, connection: Connection, **extra_data: Any)

Bases: SAMModel

Smarter API Sql Connection Manifest Connection.spec.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

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

connection: Connection

SqlConnection.spec.selector[obj]: the selector logic to use for the SqlConnection.

class smarter.models.sam.sqlconnection.SAMConnectionCommonStatus(*, account_number: str, created: datetime, dependencies: list[SAMDependency] | None = None, modified: datetime, recordLocator: str, username: str, **extra_data: Any)

Bases: SAMModel

Smarter API Connection Manifest - Status class.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

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

account_number: str

Connection.status.account_number: The account owner of this Connection.

Read only.

created: datetime

The date in which this resource was created.

Read only.

dependencies: list[SAMDependency] | None

Dependencies[List]: The resources that depend on this resource, and that must be deleted, or stop referring to it, before it can be deleted.

Lists only the resources that you can read. Read only.

modified: datetime

The date in which this resource was most recently changed.

Read only.

recordLocator: str

RecordLocator[String]: An optional identifier used to locate the resource record associated with this manifest.

Read only.

username: str

Connection.status.username: The Smarter user who created this Connection.

Read only.

class smarter.models.sam.sqlconnection.SAMSqlConnection(*, apiVersion: str, kind: str, metadata: SAMConnectionCommonMetadata, spec: SAMSqlConnectionSpec, status: SAMConnectionCommonStatus | None = None, **extra_data: Any)

Bases: SAMModel

Smarter API Manifest - SqlConnection Model.

model_config = {'extra': 'allow', 'populate_by_name': True, 'protected_namespaces': (), 'regex_engine': 'python-re', 'use_attribute_docstrings': True}

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

apiVersion: str

ApiVersion[String]: Required.

The API version of the AbstractSAMBase.

kind: str

Kind[String]: Required.

The kind of resource described by the manifest.

metadata: SAMConnectionCommonMetadata

SqlConnection.metadata[obj]: Required, the SqlConnection metadata.

spec: SAMSqlConnectionSpec

SqlConnection.spec[obj]: Required, the SqlConnection specification.

status: SAMConnectionCommonStatus | None

SqlConnection.status[obj]: Optional, Read-only.

Stateful status information about the SqlConnection.