Classes

Project

dbnl.sdk.models.Project(id: 'str', name: 'str', description: 'Optional[str]' = None)

description : str | None = None

id : str

name : str

Run

dbnl.sdk.models.Run(id: 'str', project_id: 'str', run_config_id: 'Optional[str]' = None, display_name: 'Optional[str]' = None, metadata: 'Optional[dict[str, str]]' = None, run_config: 'Optional[RunConfig]' = None, run_schema: 'Optional[RunSchema]' = None, status: "Optional[Literal['pending', 'closing', 'closed']]" = None)

display_name : str | None = None

id : str

metadata : dict[str, str] | None = None

project_id : str

run_config : RunConfig | None = None

run_config_id : str | None = None

run_schema : RunSchema | None = None

status : Literal['pending', 'closing', 'closed'] | None = None

RunQuery

dbnl.sdk.models.RunQuery(id: 'str', project_id: 'str', name: 'str', query: 'dict[str, Any]')

id : str

name : str

project_id : str

query : dict[str, Any]

TestSession

dbnl.sdk.models.TestSession(id: 'str', project_id: 'str', inputs: 'list[TestSessionInput]', status: "Literal['PENDING', 'RUNNING', 'PASSED', 'FAILED']", failure: 'Optional[str]' = None, num_tests_passed: 'Optional[int]' = None, num_tests_failed: 'Optional[int]' = None, num_tests_errored: 'Optional[int]' = None, include_tag_ids: 'Optional[list[str]]' = None, exclude_tag_ids: 'Optional[list[str]]' = None, require_tag_ids: 'Optional[list[str]]' = None)

exclude_tag_ids : list[str] | None = None

failure : str | None = None

id : str

include_tag_ids : list[str] | None = None

inputs : list[TestSessionInput]

num_tests_errored : int | None = None

num_tests_failed : int | None = None

num_tests_passed : int | None = None

project_id : str

require_tag_ids : list[str] | None = None

status : Literal['PENDING', 'RUNNING', 'PASSED', 'FAILED']

TestRecalibrationSession

dbnl.sdk.models.TestRecalibrationSession(id: 'str', project_id: 'str', test_session_id: 'str', feedback: 'str', status: "Literal['PENDING', 'RUNNING', 'COMPLETED', 'FAILED']", test_ids: 'Optional[list[str]]' = None, failure: 'Optional[str]' = None)

failure : str | None = None

feedback : str

id : str

project_id : str

status : Literal['PENDING', 'RUNNING', 'COMPLETED', 'FAILED']

test_ids : list[str] | None = None

test_session_id : str

TestGenerationSession

dbnl.sdk.models.TestGenerationSession(id: 'str', project_id: 'str', run_id: 'str', status: "Literal['PENDING', 'RUNNING', 'COMPLETED', 'FAILED']", columns: 'Optional[list[dict[str, str]]]' = None, failure: 'Optional[str]' = None, num_generated_tests: 'Optional[int]' = None)

columns : list[dict[str, str]] | None = None

failure : str | None = None

id : str

num_generated_tests : int | None = None

project_id : str

run_id : str

status : Literal['PENDING', 'RUNNING', 'COMPLETED', 'FAILED']

ResultData

dbnl.sdk.models.ResultData(columns, scalars)

columns : DataFrame

Alias for field number 0

scalars : DataFrame | None

Alias for field number 1

RunSchema

dbnl.sdk.models.RunSchema(columns: 'list[RunSchemaColumnSchema]', scalars: 'Optional[list[RunSchemaScalarSchema]]' = None, index: 'Optional[list[str]]' = None, components_dag: 'Optional[dict[str, list[str]]]' = None)

columns : list[RunSchemaColumnSchema]

components_dag : dict[str, list[str]] | None = None

index : list[str] | None = None

scalars : list[RunSchemaScalarSchema] | None = None