SQL Connection Model

Smarter API PluginData Sql Connection Manifest Constants

Smarter API Manifest - Plugin.spec

pydantic model smarter.apps.plugin.manifest.models.sql_connection.spec.Connection

Bases: SmarterBasePydanticModel

Smarter API - generic SQL Connection class.

Show JSON schema

{
   "title": "Connection",
   "description": "Smarter API - generic SQL Connection class.",
   "type": "object",
   "properties": {
      "dbEngine": {
         "description": "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']",
         "title": "Dbengine",
         "type": "string"
      },
      "hostname": {
         "description": "The remote host of the SQL connection. Should be a valid internet domain name. Example: 'localhost' or 'mysql.mycompany.com'.",
         "title": "Hostname",
         "type": "string"
      },
      "port": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The port of the SQL connection. Default values are assigned based on the dbEngine.",
         "title": "Port"
      },
      "database": {
         "description": "The name of the database to connect to. Examples: 'sales' or 'mydb'.",
         "title": "Database",
         "type": "string"
      },
      "username": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The database username.",
         "title": "Username"
      },
      "password": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The password.",
         "title": "Password"
      },
      "timeout": {
         "default": 30,
         "description": "The timeout for the database connection in seconds. Default is 30 seconds.",
         "title": "Timeout",
         "type": "integer"
      },
      "useSsl": {
         "default": false,
         "description": "Whether to use SSL/TLS for the connection.",
         "title": "Usessl",
         "type": "boolean"
      },
      "sslCert": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The SSL certificate for the connection, if required.",
         "title": "Sslcert"
      },
      "sslKey": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The SSL key for the connection, if required.",
         "title": "Sslkey"
      },
      "sslCa": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The Certificate Authority (CA) certificate for verifying the server.",
         "title": "Sslca"
      },
      "proxyHost": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The remote host of the SQL proxy connection. Should be a valid internet domain name.",
         "title": "Proxyhost"
      },
      "proxyPort": {
         "anyOf": [
            {
               "type": "integer"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The port of the SQL proxy connection.",
         "title": "Proxyport"
      },
      "proxyUsername": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The username for the proxy connection.",
         "title": "Proxyusername"
      },
      "proxyPassword": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The password for the proxy connection.",
         "title": "Proxypassword"
      },
      "sshKnownHosts": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The known_hosts file content for verifying SSH connections.",
         "title": "Sshknownhosts"
      },
      "poolSize": {
         "default": 5,
         "description": "The size of the connection pool.",
         "title": "Poolsize",
         "type": "integer"
      },
      "maxOverflow": {
         "default": 10,
         "description": "The maximum number of connections to allow beyond the pool size.",
         "title": "Maxoverflow",
         "type": "integer"
      },
      "authenticationMethod": {
         "default": "none",
         "description": "The authentication method to use for the connection. Example: 'Standard TCP/IP', 'Standard TCP/IP over SSH', 'LDAP User/Password'.",
         "title": "Authenticationmethod",
         "type": "string"
      }
   },
   "required": [
      "dbEngine",
      "hostname",
      "database"
   ]
}

Config:

• from_attributes: bool = True

• arbitrary_types_allowed: bool = True

• frozen: bool = True

Fields:

• authenticationMethod (str)

• database (str)

• dbEngine (str)

• hostname (str)

• maxOverflow (int)

• password (str | None)

• poolSize (int)

• port (int | None)

• proxyHost (str | None)

• proxyPassword (str | None)

• proxyPort (int | None)

• proxyUsername (str | None)

• sshKnownHosts (str | None)

• sslCa (str | None)

• sslCert (str | None)

• sslKey (str | None)

• timeout (int)

• useSsl (bool)

• username (str | None)

Validators:

• validate_authentication_method » authenticationMethod

• validate_database » database

• validate_db_engine » dbEngine

• validate_host » hostname

• validate_max_overflow » maxOverflow

• validate_password » password

• validate_pool_size » poolSize

• validate_port » port

• validate_proxy_host » proxyHost

• validate_proxy_port » proxyPort

• validate_ssh_known_hosts » sshKnownHosts

• validate_ssl_fields » sslCa

• validate_ssl_fields » sslCert

• validate_ssl_fields » sslKey

• validate_timeout » timeout

• validate_use_ssl » useSsl

• validate_username » username

field authenticationMethod: str = 'none'

The authentication method to use for the connection. Example: ‘Standard TCP/IP’, ‘Standard TCP/IP over SSH’, ‘LDAP User/Password’.

Validated by:

• coerce_none_strings

• validate_authentication_method

field database: str [Required]

The name of the database to connect to. Examples: ‘sales’ or ‘mydb’.

Validated by:

• coerce_none_strings

• validate_database

field dbEngine: str [Required]

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’]

Validated by:

• coerce_none_strings

• validate_db_engine

field hostname: str [Required]

The remote host of the SQL connection. Should be a valid internet domain name. Example: ‘localhost’ or ‘mysql.mycompany.com’.

Validated by:

• coerce_none_strings

• validate_host

field maxOverflow: int = 10

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

Validated by:

• coerce_none_strings

• validate_max_overflow

field password: Optional[str] = None

The password.

Validated by:

• coerce_none_strings

• validate_password

field poolSize: int = 5

The size of the connection pool.

Validated by:

• coerce_none_strings

• validate_pool_size

field port: Optional[int] = None

The port of the SQL connection. Default values are assigned based on the dbEngine.

Validated by:

• coerce_none_strings

• validate_port

field proxyHost: Optional[str] = None

The remote host of the SQL proxy connection. Should be a valid internet domain name.

Validated by:

• coerce_none_strings

• validate_proxy_host

field proxyPassword: Optional[str] = None

The password for the proxy connection.

Validated by:

• coerce_none_strings

field proxyPort: Optional[int] = None

The port of the SQL proxy connection.

Validated by:

• coerce_none_strings

• validate_proxy_port

field proxyUsername: Optional[str] = None

The username for the proxy connection.

Validated by:

• coerce_none_strings

field sshKnownHosts: Optional[str] = None

The known_hosts file content for verifying SSH connections.

Validated by:

• coerce_none_strings

• validate_ssh_known_hosts

field sslCa: Optional[str] = None

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

Validated by:

• coerce_none_strings

• validate_ssl_fields

field sslCert: Optional[str] = None

The SSL certificate for the connection, if required.

Validated by:

• coerce_none_strings

• validate_ssl_fields

field sslKey: Optional[str] = None

The SSL key for the connection, if required.

Validated by:

• coerce_none_strings

• validate_ssl_fields

field timeout: int = 30

The timeout for the database connection in seconds. Default is 30 seconds.

Validated by:

• coerce_none_strings

• validate_timeout

field useSsl: bool = False

Whether to use SSL/TLS for the connection.

Validated by:

• coerce_none_strings

• validate_use_ssl

field username: Optional[str] = None

The database username.

Validated by:

• coerce_none_strings

• validate_username

validator validate_authentication_method  »  authenticationMethod

Return type:

str

validator validate_database  »  database

Return type:

str

validator validate_db_engine  »  dbEngine

Return type:

str

validator validate_host  »  hostname

Return type:

str

validator validate_max_overflow  »  maxOverflow

Return type:

int

validator validate_password  »  password

Return type:

str

validator validate_pool_size  »  poolSize

Return type:

int

validator validate_port  »  port

Return type:

int

validator validate_proxy_host  »  proxyHost

Return type:

str

validator validate_proxy_port  »  proxyPort

Return type:

int

validator validate_ssh_known_hosts  »  sshKnownHosts

Return type:

Optional[str]

validator validate_ssl_fields  »  sslKey, sslCert, sslCa

Return type:

Optional[str]

validator validate_timeout  »  timeout

Return type:

int

validator validate_use_ssl  »  useSsl

Return type:

bool

validator validate_username  »  username

Return type:

str

pydantic model smarter.apps.plugin.manifest.models.sql_connection.spec.SAMSqlConnectionSpec

Bases: AbstractSAMSpecBase

Smarter API Sql Connection Manifest Connection.spec

Show JSON schema

{
   "title": "SAMSqlConnectionSpec",
   "description": "Smarter API Sql Connection Manifest Connection.spec",
   "type": "object",
   "properties": {
      "connection": {
         "$ref": "#/$defs/Connection",
         "description": "SqlConnection.spec.selector[obj]: the selector logic to use for the SqlConnection"
      }
   },
   "$defs": {
      "Connection": {
         "description": "Smarter API - generic SQL Connection class.",
         "properties": {
            "dbEngine": {
               "description": "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']",
               "title": "Dbengine",
               "type": "string"
            },
            "hostname": {
               "description": "The remote host of the SQL connection. Should be a valid internet domain name. Example: 'localhost' or 'mysql.mycompany.com'.",
               "title": "Hostname",
               "type": "string"
            },
            "port": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The port of the SQL connection. Default values are assigned based on the dbEngine.",
               "title": "Port"
            },
            "database": {
               "description": "The name of the database to connect to. Examples: 'sales' or 'mydb'.",
               "title": "Database",
               "type": "string"
            },
            "username": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The database username.",
               "title": "Username"
            },
            "password": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The password.",
               "title": "Password"
            },
            "timeout": {
               "default": 30,
               "description": "The timeout for the database connection in seconds. Default is 30 seconds.",
               "title": "Timeout",
               "type": "integer"
            },
            "useSsl": {
               "default": false,
               "description": "Whether to use SSL/TLS for the connection.",
               "title": "Usessl",
               "type": "boolean"
            },
            "sslCert": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The SSL certificate for the connection, if required.",
               "title": "Sslcert"
            },
            "sslKey": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The SSL key for the connection, if required.",
               "title": "Sslkey"
            },
            "sslCa": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The Certificate Authority (CA) certificate for verifying the server.",
               "title": "Sslca"
            },
            "proxyHost": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The remote host of the SQL proxy connection. Should be a valid internet domain name.",
               "title": "Proxyhost"
            },
            "proxyPort": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The port of the SQL proxy connection.",
               "title": "Proxyport"
            },
            "proxyUsername": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The username for the proxy connection.",
               "title": "Proxyusername"
            },
            "proxyPassword": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The password for the proxy connection.",
               "title": "Proxypassword"
            },
            "sshKnownHosts": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The known_hosts file content for verifying SSH connections.",
               "title": "Sshknownhosts"
            },
            "poolSize": {
               "default": 5,
               "description": "The size of the connection pool.",
               "title": "Poolsize",
               "type": "integer"
            },
            "maxOverflow": {
               "default": 10,
               "description": "The maximum number of connections to allow beyond the pool size.",
               "title": "Maxoverflow",
               "type": "integer"
            },
            "authenticationMethod": {
               "default": "none",
               "description": "The authentication method to use for the connection. Example: 'Standard TCP/IP', 'Standard TCP/IP over SSH', 'LDAP User/Password'.",
               "title": "Authenticationmethod",
               "type": "string"
            }
         },
         "required": [
            "dbEngine",
            "hostname",
            "database"
         ],
         "title": "Connection",
         "type": "object"
      }
   },
   "required": [
      "connection"
   ]
}

Config:

• from_attributes: bool = True

• arbitrary_types_allowed: bool = True

• frozen: bool = True

Fields:

• connection (smarter.apps.plugin.manifest.models.sql_connection.spec.Connection)

Validators:

field connection: Connection [Required]

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

Validated by:

• coerce_none_strings

class_identifier: ClassVar[str] = 'SqlConnection.spec'

Smarter API Plugin Manifest

pydantic model smarter.apps.plugin.manifest.models.sql_connection.model.SAMSqlConnection

Bases: AbstractSAMBase

Smarter API Manifest - SqlPlugin Connection Model

Show JSON schema

{
   "title": "SAMSqlConnection",
   "description": "Smarter API Manifest - SqlPlugin Connection Model",
   "type": "object",
   "properties": {
      "apiVersion": {
         "description": "apiVersion[String]: Required. The API version of the AbstractSAMBase.",
         "title": "Apiversion",
         "type": "string"
      },
      "kind": {
         "description": "kind[String]: Required. The kind of resource described by the manifest.",
         "title": "Kind",
         "type": "string"
      },
      "metadata": {
         "$ref": "#/$defs/SAMConnectionCommonMetadata",
         "description": "SqlConnection.metadata[obj]: Required, the SqlConnection metadata."
      },
      "spec": {
         "$ref": "#/$defs/SAMSqlConnectionSpec",
         "description": "SqlConnection.spec[obj]: Required, the SqlConnection specification."
      },
      "status": {
         "anyOf": [
            {
               "$ref": "#/$defs/SAMConnectionCommonStatus"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "SqlConnection.status[obj]: Optional, Read-only. Stateful status information about the SqlConnection."
      }
   },
   "$defs": {
      "Connection": {
         "description": "Smarter API - generic SQL Connection class.",
         "properties": {
            "dbEngine": {
               "description": "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']",
               "title": "Dbengine",
               "type": "string"
            },
            "hostname": {
               "description": "The remote host of the SQL connection. Should be a valid internet domain name. Example: 'localhost' or 'mysql.mycompany.com'.",
               "title": "Hostname",
               "type": "string"
            },
            "port": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The port of the SQL connection. Default values are assigned based on the dbEngine.",
               "title": "Port"
            },
            "database": {
               "description": "The name of the database to connect to. Examples: 'sales' or 'mydb'.",
               "title": "Database",
               "type": "string"
            },
            "username": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The database username.",
               "title": "Username"
            },
            "password": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The password.",
               "title": "Password"
            },
            "timeout": {
               "default": 30,
               "description": "The timeout for the database connection in seconds. Default is 30 seconds.",
               "title": "Timeout",
               "type": "integer"
            },
            "useSsl": {
               "default": false,
               "description": "Whether to use SSL/TLS for the connection.",
               "title": "Usessl",
               "type": "boolean"
            },
            "sslCert": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The SSL certificate for the connection, if required.",
               "title": "Sslcert"
            },
            "sslKey": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The SSL key for the connection, if required.",
               "title": "Sslkey"
            },
            "sslCa": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The Certificate Authority (CA) certificate for verifying the server.",
               "title": "Sslca"
            },
            "proxyHost": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The remote host of the SQL proxy connection. Should be a valid internet domain name.",
               "title": "Proxyhost"
            },
            "proxyPort": {
               "anyOf": [
                  {
                     "type": "integer"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The port of the SQL proxy connection.",
               "title": "Proxyport"
            },
            "proxyUsername": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The username for the proxy connection.",
               "title": "Proxyusername"
            },
            "proxyPassword": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The password for the proxy connection.",
               "title": "Proxypassword"
            },
            "sshKnownHosts": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "The known_hosts file content for verifying SSH connections.",
               "title": "Sshknownhosts"
            },
            "poolSize": {
               "default": 5,
               "description": "The size of the connection pool.",
               "title": "Poolsize",
               "type": "integer"
            },
            "maxOverflow": {
               "default": 10,
               "description": "The maximum number of connections to allow beyond the pool size.",
               "title": "Maxoverflow",
               "type": "integer"
            },
            "authenticationMethod": {
               "default": "none",
               "description": "The authentication method to use for the connection. Example: 'Standard TCP/IP', 'Standard TCP/IP over SSH', 'LDAP User/Password'.",
               "title": "Authenticationmethod",
               "type": "string"
            }
         },
         "required": [
            "dbEngine",
            "hostname",
            "database"
         ],
         "title": "Connection",
         "type": "object"
      },
      "SAMConnectionCommonMetadata": {
         "description": "Smarter API Connection Manifest - common Metadata class.",
         "properties": {
            "name": {
               "description": "The camelCase name of the manifest resource",
               "title": "Name",
               "type": "string"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The description for this resource. Be brief. Keep it under 255 characters.",
               "title": "Description"
            },
            "version": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The semantic version of the manifest. Example: 0.1.0",
               "title": "Version"
            },
            "tags": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The tags of the manifest. Used for generic resource categorization and search. Example: ['tag1', 'tag2']",
               "title": "Tags"
            },
            "annotations": {
               "anyOf": [
                  {
                     "items": {
                        "additionalProperties": {
                           "anyOf": [
                              {
                                 "type": "string"
                              },
                              {
                                 "type": "integer"
                              },
                              {
                                 "type": "number"
                              },
                              {
                                 "type": "boolean"
                              },
                              {
                                 "format": "date",
                                 "type": "string"
                              },
                              {
                                 "format": "date-time",
                                 "type": "string"
                              },
                              {
                                 "pattern": "^(?!^[-+.]*$)[+-]?0*\\d*\\.?\\d*$",
                                 "type": "string"
                              },
                              {
                                 "format": "uuid",
                                 "type": "string"
                              },
                              {
                                 "format": "binary",
                                 "type": "string"
                              },
                              {
                                 "items": {},
                                 "type": "array"
                              },
                              {
                                 "additionalProperties": true,
                                 "type": "object"
                              }
                           ]
                        },
                        "type": "object"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "description": "The manifest annotations. Used for storing arbitrary metadata as\n            key-value pairs. Example: [{'smarter.sh/test-manifest/project-name': 'Scooby dooby do'}]. The\n            key should be a valid url-friendly string. The value accepts\n            multi-line string values (YAML block scalars) and various scalar types including\n            str, int, float, bool, datetime.date, datetime.datetime, decimal.Decimal, uuid.UUID, bytes, list, dict.\n            ",
               "title": "Annotations"
            }
         },
         "required": [
            "name",
            "description",
            "version"
         ],
         "title": "SAMConnectionCommonMetadata",
         "type": "object"
      },
      "SAMConnectionCommonStatus": {
         "description": "Smarter API Connection Manifest - Status class.",
         "properties": {
            "recordLocator": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "description": "recordLocator[String]: An optional identifier used to locate the resource record associated with this manifest. Read only.",
               "title": "Recordlocator"
            },
            "created": {
               "description": "The date in which this resource was created. Read only.",
               "format": "date-time",
               "title": "Created",
               "type": "string"
            },
            "modified": {
               "description": "The date in which this resource was most recently changed. Read only.",
               "format": "date-time",
               "title": "Modified",
               "type": "string"
            },
            "account_number": {
               "description": "Connection.status.account_number: The account owner of this Connection. Read only.",
               "title": "Account Number",
               "type": "string"
            },
            "username": {
               "description": "Connection.status.account_number: The Smarter user who created this Connection. Read only.",
               "title": "Username",
               "type": "string"
            }
         },
         "required": [
            "created",
            "modified",
            "account_number",
            "username"
         ],
         "title": "SAMConnectionCommonStatus",
         "type": "object"
      },
      "SAMSqlConnectionSpec": {
         "description": "Smarter API Sql Connection Manifest Connection.spec",
         "properties": {
            "connection": {
               "$ref": "#/$defs/Connection",
               "description": "SqlConnection.spec.selector[obj]: the selector logic to use for the SqlConnection"
            }
         },
         "required": [
            "connection"
         ],
         "title": "SAMSqlConnectionSpec",
         "type": "object"
      }
   },
   "required": [
      "apiVersion",
      "kind",
      "metadata",
      "spec"
   ]
}

Config:

• from_attributes: bool = True

• arbitrary_types_allowed: bool = True

• frozen: bool = True

Fields:

• metadata (smarter.apps.plugin.manifest.models.common.connection.metadata.SAMConnectionCommonMetadata)

• spec (smarter.apps.plugin.manifest.models.sql_connection.spec.SAMSqlConnectionSpec)

• status (smarter.apps.plugin.manifest.models.common.connection.status.SAMConnectionCommonStatus | None)

Validators:

• validate_metadata » metadata

field metadata: SAMConnectionCommonMetadata [Required]

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

Validated by:

• coerce_none_strings

• validate_metadata

field spec: SAMSqlConnectionSpec [Required]

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

Validated by:

• coerce_none_strings

field status: Optional[SAMConnectionCommonStatus] = None

SqlConnection.status[obj]: Optional, Read-only. Stateful status information about the SqlConnection.

Validated by:

• coerce_none_strings

class_identifier: ClassVar[str] = 'SqlConnection'