latestOpenAPI 3.0.32026-08-10119559584.8 KB

6d091bc86a33

JDBC Schema Ingestion

Create a JDBC schema ingestion

Create a schema from a JDBC data source. <br />This operation is deprecated and it will be removed the next major release

post/schemas/jdbc

Request body

schemaNamestring required

The schema name

jdbcDriverIdstring uuid required

The UUID of the JdbcDriver to use to connect to a JDBC source for ingestion.

propertiesobject required

The properties that will be passed to the JDBC driver to connect to the source.

userstring required

The username for the connection. If the user is not requested, specify an empty String

passwordstring[]

The password for the connection. It can be specified as array of char (more secure) or as a String

jdbcConnectionStringstring

The connection string that will be used instead of the one from the JdbcDriver.

descriptionstring

The description of the schema to be added.

ownerIdstring uuid required

The id of the user who will be assigned as the owner of the produced domain.

storeCredentialsboolean

Specify if the credentials should be stored into the database.

cronExpressionstring

The cron expression to enable the automatic refresh. If not set, it will delete the cron job if one was present.<br />It requires storeCredential to be set to true.<br />The system supports both Unix Crontab format and Quartz cron format. However, Quartz crons are eventually transformed into Unix crons, during which any fields representing seconds or years are quietly discarded

cronTimeZonestring

The cron time zone. If a cron expression is set, a time zone is mandatory.

extractDataSampleboolean

Specify if sampleData should be extracted from the database.

executeProfilingboolean

Specify if profiling should be executed.

detectAdvancedDataTypesboolean

Specify if advanced data types should be detected.

tablesToSkipstring[]

The list table names that shouldn't be ingested. The names can contain * wildcards toskip multiple tables with similar names.

jobServerstring

Specify the jobserver id where to submit the ingestion.

Response

The Job which represents the ongoing schema ingestion

idstring uuid required
createdBystring uuid required
createdOnstring date-time required
startDatestring date-time required
endDatestring date-time
status'Waiting' | 'Running' | 'Completed' | 'Failed' required
reportobject