Skip to content

SqlClient

Description: A client for executing SQL queries using SQLAlchemy. See https://docs.sqlalchemy.org/ for connection configuration details.

Performs cursory checks when select_only is set to True. Additionally ensure user is restricted to allowed permissions.

PropertyPatternTypeDeprecatedDefinitionTitle/Description
- implementationNoconstNo-SqlClient
- protocolNostringNo-Protocol
- connection_stringNostringNo-Connection String
- engine_kwargsNoobjectNo-Engine Kwargs
- select_onlyNobooleanNo-Select Only
- metadataNoarrayNo-Metadata

1. Property implementation

Typeconst
RequiredNo

Description: SqlClient

Specific value: "SqlClient"

2. Property protocol

Title: Protocol

Typestring
RequiredNo
Defaultnull

3. Property connection_string

Title: Connection String

Typestring
RequiredNo
Default"sqlite+aiosqlite:///:memory:"

Description: SQLAlchemy connection string. See https://docs.sqlalchemy.org/en/20/core/engines.html for more information.

4. Property engine_kwargs

Title: Engine Kwargs

Typeobject
RequiredNo
Additional properties[Any type: allowed]
Default{}

5. Property select_only

Title: Select Only

Typeboolean
RequiredNo
Defaultfalse

6. Property metadata

Title: Metadata

Typearray
RequiredNo
Default[{"name": "tables", "metadata": [], "remove_falsy_metadata": true}]
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
MetadataAttribute-

6.1. MetadataAttribute

Typeobject
RequiredNo
Additional properties[Any type: allowed]
Defined in#/$defs/MetadataAttribute
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ nameNostringNo-Name
- metadataNoCombinationNo-Metadata
- remove_falsy_metadataNobooleanNo-Remove Falsy Metadata

6.1.1. Property name

Title: Name

Typestring
RequiredYes

6.1.2. Property metadata

Title: Metadata

Typecombining
RequiredNo
Additional properties[Any type: allowed]
Default[]
Any of(Option)
item 0
item 1
6.1.2.1. Property item 0
Typearray
RequiredNo
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
MetadataAttribute-
6.1.2.1.1. MetadataAttribute
Typeobject
RequiredNo
Additional properties[Any type: allowed]
Same definition asMetadataAttribute
6.1.2.2. Property item 1
Typearray of string
RequiredNo
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
item 1 items-
6.1.2.2.1. item 1 items
Typestring
RequiredNo

6.1.3. Property remove_falsy_metadata

Title: Remove Falsy Metadata

Typeboolean
RequiredNo
Defaulttrue