Zum Inhalt

digna Python SDK Ressourcen 2026.11

Diese Seite dokumentiert die Ressourcen-Clients des digna Python SDK. Jede Ressource kapselt die zugehörigen Endpunkte der Stable API in einer einheitlichen, pythonischen Schnittstelle mit vorhersehbaren Methodennamen.

DignaClient stellt pro API-Bereich ein Ressourcenobjekt bereit. Jede Ressource kapselt die zugehörigen Endpunkte der Stable API mit pythonischen Methodennamen.

Ressource Attribut Endpunkte
ProjectsResource client.projects /v1/projects
DataSourcesResource client.data_sources /v1/data-sources
DataSetsResource client.data_sets /v1/data-sets
AttributesResource client.attributes /v1/attributes
CheckDefinitionsResource client.check_definitions /v1/check-definitions
DbConnectionsResource client.db_connections /v1/db-connections
InspectionRequestsResource client.inspection_requests /v1/inspection-requests
InspectionStatusesResource client.inspection_statuses /v1/inspection-statuses/*

digna_sdk.resources.projects.ProjectsResource(client)

Resource client for /v1/projects.

get(project_id)

Get a single project by id.

Parameters:

Name Type Description Default
project_id int

Project ID.

 required

list(*, limit=None)

List all projects.

Parameters:

Name Type Description Default
limit int | None

Maximum number of rows to return (API default: 200, max: 5000).

 None

digna_sdk.resources.data_sources.DataSourcesResource(client)

Resource client for /v1/data-sources.

create(*, project_id, db_connection_id, name, kind, query_mode, object, modules, report_empty_datasets=False, snapshot_filter='', snapshot_query='')

Create a new data source.

Parameters:

Name Type Description Default
project_id int

The project this data source belongs to.

 required
db_connection_id int

The database connection used to query the source table/view.

 required
name str

Data source name.

 required
kind StableDataSourceKind

Whether the source is a table, view, or query.

 required
query_mode StableDataSourceQueryMode

Whether snapshots are queried individually or combined.

 required
object DataSourceObject

The catalog/schema/table location of the source data.

 required
modules DataSourceModules

Which inspection modules are enabled for this data source.

 required
report_empty_datasets bool

Whether to still report datasets that hold no rows.

 False
snapshot_filter str

Row filter expression used to select a snapshot.

 ''
snapshot_query str

Custom query used instead of object when kind is QUERY.

 ''

delete(data_source_id)

Delete a data source.

Parameters:

Name Type Description Default
data_source_id int

Data source ID.

 required

get(data_source_id)

Get a single data source by id.

Parameters:

Name Type Description Default
data_source_id int

Data source ID.

 required

list(project_id, *, limit=None)

List data sources belonging to a project.

Parameters:

Name Type Description Default
project_id int

Filter by project ID.

 required
limit int | None

Maximum number of rows to return (API default: 200, max: 5000).

 None

update(data_source_id, *, db_connection_id, name, kind, query_mode, object, modules, report_empty_datasets=False, snapshot_filter='', snapshot_query='')

Update an existing data source.

Parameters:

Name Type Description Default
data_source_id int

Data source ID.

 required
db_connection_id int

The database connection used to query the source table/view.

 required
name str

Data source name.

 required
kind StableDataSourceKind

Whether the source is a table, view, or query.

 required
query_mode StableDataSourceQueryMode

Whether snapshots are queried individually or combined.

 required
object DataSourceObject

The catalog/schema/table location of the source data.

 required
modules DataSourceModules

Which inspection modules are enabled for this data source.

 required
report_empty_datasets bool

Whether to still report datasets that hold no rows.

 False
snapshot_filter str

Row filter expression used to select a snapshot.

 ''
snapshot_query str

Custom query used instead of object when kind is QUERY.

 ''

digna_sdk.resources.data_sets.DataSetsResource(client)

Resource client for /v1/data-sets.

create(*, data_source_id, name, kind, filter_expression='', grouping_expression='')

Create a new dataset.

Parameters:

Name Type Description Default
data_source_id int

The data source this dataset is derived from.

 required
name str

Data set name.

 required
kind StableDataSetKind

Whether the dataset is static, dynamic, or hybrid.

 required
filter_expression str

Row filter expression applied to the data source.

 ''
grouping_expression str

Grouping expression used to split the data source into datasets.

 ''

delete(dataset_id)

Delete a dataset.

Parameters:

Name Type Description Default
dataset_id int

Data set ID.

 required

get(dataset_id)

Get a single dataset by id.

Parameters:

Name Type Description Default
dataset_id int

Data set ID.

 required

list(data_source_id, *, limit=None)

List datasets belonging to a data source.

Parameters:

Name Type Description Default
data_source_id int

Filter by data source ID.

 required
limit int | None

Maximum number of rows to return (API default: 200, max: 5000).

 None

update(dataset_id, *, name, kind, filter_expression='', grouping_expression='')

Update an existing dataset.

Parameters:

Name Type Description Default
dataset_id int

Data set ID.

 required
name str

Data set name.

 required
kind StableDataSetKind

Whether the dataset is static, dynamic, or hybrid.

 required
filter_expression str

Row filter expression applied to the data source.

 ''
grouping_expression str

Grouping expression used to split the data source into datasets.

 ''

digna_sdk.resources.attributes.AttributesResource(client)

Resource client for /v1/attributes.

create(*, data_source_id, name, data_type, category, statistic_ids)

Create a new attribute.

Parameters:

Name Type Description Default
data_source_id int

The data source this attribute belongs to.

 required
name str

Attribute name.

 required
data_type str

The underlying column data type (e.g. "double precision").

 required
category StableAttributeCategory

How the attribute's values should be treated statistically.

 required
statistic_ids list[int]

IDs of the statistics to compute check definitions for.

 required

delete(attribute_id)

Delete an attribute.

Parameters:

Name Type Description Default
attribute_id int

Attribute ID.

 required

get(attribute_id)

Get a single attribute by id.

Parameters:

Name Type Description Default
attribute_id int

Attribute ID.

 required

list(data_source_id, *, limit=None)

List attributes belonging to a data source.

Parameters:

Name Type Description Default
data_source_id int

Filter by data source ID.

 required
limit int | None

Maximum number of rows to return (API default: 200, max: 5000).

 None

update(attribute_id, *, name, data_type, category, statistic_ids)

Update an existing attribute.

Parameters:

Name Type Description Default
attribute_id int

Attribute ID.

 required
name str

Attribute name.

 required
data_type str

The underlying column data type (e.g. "double precision").

 required
category StableAttributeCategory

How the attribute's values should be treated statistically.

 required
statistic_ids list[int]

IDs of the statistics to compute check definitions for.

 required

digna_sdk.resources.check_definitions.CheckDefinitionsResource(client)

Resource client for /v1/check-definitions.

list(data_source_id, *, limit=None)

List check definitions belonging to a data source.

Parameters:

Name Type Description Default
data_source_id int

Filter by data source ID.

 required
limit int | None

Maximum number of rows to return (API default: 200, max: 5000).

 None

digna_sdk.resources.db_connections.DbConnectionsResource(client)

Resource client for /v1/db-connections.

get(db_connection_id)

Get a single database connection by id.

Parameters:

Name Type Description Default
db_connection_id int

Db connection ID.

 required

list(*, limit=None)

List all database connections.

Parameters:

Name Type Description Default
limit int | None

Maximum number of rows to return (API default: 200, max: 5000).

 None

digna_sdk.resources.inspection_requests.InspectionRequestsResource(client)

Resource client for /v1/inspection-requests.

get_status(inspection_request_id)

Poll the status of a previously submitted inspection request.

Parameters:

Name Type Description Default
inspection_request_id int

Inspection request ID.

 required

submit(*, project_id, data_source_ids, start_date, end_date, mode, include_all_data_sources=False, use_notification=False, monthly_mode_days=None, weekly_mode_weekdays=None, inspection_job_id=None)

Submit a new inspection request for a project's data sources.

Parameters:

Name Type Description Default
project_id int

The project the data sources belong to.

 required
data_source_ids list[int]

IDs of the data sources to inspect. Ignored when include_all_data_sources is True.

 required
start_date date

First date to inspect (inclusive).

 required
end_date date

Last date to inspect (inclusive).

 required
mode StableInspectionRequestMode

How the requested date range should be scheduled (daily, weekly, monthly).

 required
include_all_data_sources bool

Inspect every data source in the project instead of just data_source_ids.

 False
use_notification bool

Whether to send notifications for this request.

 False
monthly_mode_days list[int] | None

Days of the month to run on, when mode is MONTHLY.

 None
weekly_mode_weekdays list[StableInspectionRequestWeekday] | None

Weekdays to run on, when mode is WEEKLY.

 None
inspection_job_id int | None

Optional ID linking this request to an existing inspection job.

 None

wait_until_finished(inspection_request_id, *, poll_interval=2.0, timeout=300.0)

Repeatedly call get_status until the request reaches a terminal state.

Parameters:

Name Type Description Default
inspection_request_id int

Inspection request ID, as returned by submit.

 required
poll_interval float

Seconds to sleep between status checks.

 2.0
timeout float

Maximum seconds to wait before giving up.

 300.0

Raises:

Type Description
DignaInspectionRequestFailed

if the request ends as FAILED, ABORTED, or CANCELLED.
TimeoutError

if timeout seconds elapse before a terminal state is reached.

digna_sdk.resources.inspection_statuses.InspectionStatusesResource(client)

Resource client for /v1/inspection-statuses/*.

for_data_sources(*, start_date, end_date, project_id=None, data_source_id=None, data_source_name_like=None, is_inspected=None, data_volume_status=None, data_anomaly_status=None, data_validation_status=None, data_analytics_status=None, inspection_status=None, limit=None)

Get daily inspection statuses for one or all data sources.

Parameters:

Name Type Description Default
start_date date

Start date (inclusive).

 required
end_date date

End date (inclusive).

 required
project_id int | None

Filter by project ID.

 None
data_source_id int | None

Filter by data source ID.

 None
data_source_name_like str | None

Filter by data source name.

 None
is_inspected bool | None

Filter by inspected state.

 None
data_volume_status TestStatus | None

Filter by data volume status.

 None
data_anomaly_status TestStatus | None

Filter by data anomaly status.

 None
data_validation_status TestStatus | None

Filter by data validation status.

 None
data_analytics_status TestStatus | None

Filter by data analytics status.

 None
inspection_status InspectionStatus | None

Filter by overall inspection status.

 None
limit int | None

Maximum number of rows to return (API default: 200, max: 5000).

 None

for_datasets(data_source_id, *, start_date, end_date, dataset_id=None, data_volume_status=None, data_anomaly_status=None, data_validation_status=None, data_analytics_status=None, inspection_status=None, limit=None)

Get daily inspection statuses for one or all datasets of a data source.

Parameters:

Name Type Description Default
data_source_id int

Filter by data source ID.

 required
start_date date

Start date (inclusive).

 required
end_date date

End date (inclusive).

 required
dataset_id int | None

Filter by data set ID.

 None
data_volume_status TestStatus | None

Filter by data volume status.

 None
data_anomaly_status TestStatus | None

Filter by data anomaly status.

 None
data_validation_status TestStatus | None

Filter by data validation status.

 None
data_analytics_status TestStatus | None

Filter by data analytics status.

 None
inspection_status InspectionStatus | None

Filter by overall inspection status.

 None
limit int | None

Maximum number of rows to return (API default: 200, max: 5000).

 None

for_projects(project_id, *, start_date, end_date, limit=None)

Get daily inspection statuses for a project.

Parameters:

Name Type Description Default
project_id int

Project ID.

 required
start_date date

Start date (inclusive).

 required
end_date date

End date (inclusive).

 required
limit int | None

Maximum number of rows to return (API default: 200, max: 5000).

 None