The options property allows you to configure additional settings of the specified data source definition’s version.

Example JSON

{
    "batchSize": true,
    "convertBooleanToNumeric": true,
    "createChangeLogs": true,
    "createVersions": false
}

Nested properties: Options available to all providers

PropertyDescriptionValuesMandatory
batchSizeSize of a data extraction batch (number of rows per extraction).integerYes
convertBooleantoNumericConverts boolean values to numeric format.booleanYes
createChangeLogsDetermines whether a changelog, which records a list of all changes made, is maintained.booleanYes
createVersionsDetermines if versions of data source definitions are created and stored. Default value is false.booleanYes
ingestionFormatFormat of the ingestion.stringNo

Provider-specific options

Below, you will find the list of settings that can be configured during data source creation in the UI depending on the provider.

The last column, Template, indicates which of these options need to be configured in the Additional Settings field in the last data source creation step (= they are NOT in the data source creation template).

dbt

PropertyDescriptionValuesMandatoryDefaultTemplate
Account Iddbt account ID.stringYes-Yes
Project Filter RegExpList of projects to scan. Use regular expressions, e.g.,  Project 1Project 2Project 3.stringNo
Environment Filter RegExpList of environments to scan.stringNo-Yes
Scan Only Production Deployment TypeDetermines if only production environments are scanned.booleanNo-Yes
Job Filter RegExpList of dbt jobs to scan.stringNo-Yes
createChangeLogsDetermines whether a changelog, which records a list of all changes made, is maintained.booleanNotrueNo
createVersionsDetermines if versions of data source definitions are created and stored.booleanNofalseNo

Google Big Query

PropertyDescriptionValuesMandatoryDefaultTemplate
DatasetsList of databases to ingest.arrayYes-Yes
batchSizeSize of a data extraction batch (number or rows per extraction).integerNo5000No
convertBooleanToNumericConverts boolean values to numeric format.stringNotrueNo
createChangeLogsDetermines whether a changelog, which records a list of all changes made, is maintained.booleanNotrueNo
createVersionsDetermines if versions of data source definitions are created and stored.booleanNofalseNo

Keboola

PropertyDescriptionValuesMandatoryDefaultTemplate
Projects Filter RegExpList of projects to scan. Use regular expressions, e.g.,  Project 1Project 2Project 3.stringNo
Include LineageDetermines if lineages should be included.booleanNofalseYes
createChangeLogsDetermines whether a changelog, which records a list of all changes made, is maintained.booleanNotrueNo
createVersionsDetermines if versions of data source definitions are created and stored.booleanNofalseNo

Power BI

PropertyDescriptionValuesMandatoryDefaultTemplate
Included WorkspacesList of integrated workspaces, separated by commas.arrayNo-Yes
Excluded WorkspacesList of excluded workspaces, separated by commas.arrayNo-Yes
Remove Empty FieldsDetermines if empty fields should be removed.booleanNo-Yes
Workspace Filter ExpressionCase-sensitive filter. Use simple like-style expressions, e.g., %finance% to integrate all workspaces with “finance” in the name.stringNo-Yes
Workspace Filter Regular ExpressionFull-featured regex-based filtering for more granular workspace name selection.stringNo-Yes
Workspace TypesTypes of workspaces.stringNo-Yes
createChangeLogsDetermines whether a changelog, which records a list of all changes made, is maintained.booleanNotrueNo
createVersionsDetermines if versions of data source definitions are created and stored.booleanNofalseNo
dataSetSchemaExtracts the schema of the dataset, including tables, columns, and data types.booleanNotrueNo
dataSetExpressionsExtracts DAX expressions used in calculated columns, measures, and calculated tables.booleanNotrueNo
dataSourceDetailsExtracts metadata about the underlying data sources (e.g., SQL Server, Snowflake, API connections) used in Power BI.booleanNotrueNo
getArtifactUsersExtracts user access permissions for datasets, reports, and workspaces.booleanNotrueNo
lineageExtracts data lineage information, showing how data flows from sources to reports and dashboards.booleanNotrueNo
loadDatasetRefreshScheduleExtracts the dataset refresh schedule, including frequency and last refresh details.booleanNotrueNo
logResponsesLogs API responses related to the extraction process (useful for debugging).booleanNo-No
usePowerBiAnalyticServerDetermines if Power BI’s internal analytic server is used to extract databooleanNofalseNo

SQL providers (Amazon Redshift, SQL Server, MySql, Oracle, PostgreSQL, Snowflake)

PropertyDescriptionValuesMandatoryDefaultTemplate
DatabasesList of databases to ingest.arrayYes-Yes
batchSizeSize of a data extraction batch (number or rows per extraction).integerNo5000No
convertBooleanToNumericConverts boolean values to numeric format.booleanNo-No
createChangeLogsDetermines whether a changelog, which records a list of all changes made, is maintained.booleanNotrueNo
createVersionsDetermines if versions of data source definitions are created and stored.booleanNofalseNo

Tableau

PropertyDescriptionValuesMandatoryDefaultTemplate
Download ImagesDetermines if images should be downloaded.booleanNofalseYes
Ignored ProjectsList of projects that should be ignored (not ingested).arrayNo-Yes
createChangeLogsDetermines whether a changelog, which records a list of all changes made, is maintained.booleanNotrueNo
createVersionsDetermines if versions of data source definitions are created and stored.booleanNofalseNo