Organization
Users and User Groups
Permissions
Data Source
    Data Source - Declarative APIs
    Data Source - Entity APIs
    Test Connection
    Invalidate Cache
    Manage Permissions
    Available Drivers
    Scanning
      Scan a database to get a physical data model (PDM)postGet a list of schema names of a databasegetCollect metadata about SQL querypost
    Data source files import
    Data source files analysis
    Data source staging location
    Data source files listing
    Data source files deletion
    Data source files manifest read
Workspaces
Logical Data Model
Analytical Objects
Reporting
Export & Automations
Other
Schemas
powered by Zudoku
OpenAPI definition

Scanning (3.51)

Endpoint:/

Scan a database to get a physical data model (PDM)

POST
/api/v1/actions/dataSources/{dataSourceId}/scan

It scans a database and transforms its metadata to a declarative definition of the physical data model (PDM). The result of the request contains the mentioned physical data model (PDM) of a database within warning, for example, about unsupported columns.

Scan a database to get a physical data model (PDM) › path Parameters

  • dataSourceIdstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

    Data source id

Scan a database to get a physical data model (PDM) › Request Body

  • scanTablesboolean · required

    A flag indicating whether the tables should be scanned.

    Example: true
  • scanViewsboolean · required

    A flag indicating whether the views should be scanned.

    Example: true
  • separatorstring · required

    A separator between prefixes and the names.

    Example: __
  • schematastring[]

    What schemata will be scanned.

    Example: ["tpch","demo"]
  • tablePrefixstring

    Tables starting with this prefix will be scanned. The prefix is then followed by the value of separator parameter. Given the table prefix is out_table and separator is __, the table with name like out_table__customers will be scanned.

    Example: out_table
  • viewPrefixstring

    Views starting with this prefix will be scanned. The prefix is then followed by the value of separator parameter. Given the view prefix is out_view and separator is __, the table with name like out_view__us_customers will be scanned.

    Example: out_view

Scan a database to get a physical data model (PDM) › Responses

The result of the scan.

  • pdmobject · required

    A physical data model (PDM) tables.

  • warningsobject[] · required
POST /api/v1/actions/dataSources/{dataSourceId}/scan

Get a list of schema names of a database

GET
/api/v1/actions/dataSources/{dataSourceId}/scanSchemata

It scans a database and reads metadata. The result of the request contains a list of schema names of a database.

Get a list of schema names of a database › path Parameters

  • dataSourceIdstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

    Data source id

Get a list of schema names of a database › Responses

The result of the scan schemata

  • schemaNamesstring[] · required
GET /api/v1/actions/dataSources/{dataSourceId}/scanSchemata

Collect metadata about SQL query

POST
/api/v1/actions/dataSources/{dataSourceId}/scanSql

It executes SQL query against specified data source and extracts metadata. Metadata consist of column names and column data types. It can optionally provide also preview of data returned by SQL query

Collect metadata about SQL query › path Parameters

  • dataSourceIdstring · pattern: ^(?!\.)[.A-Za-z0-9_-… · required

    Data source id

Collect metadata about SQL query › Request Body

  • sqlstring · required

    SQL query to be analyzed.

    Example: SELECT a.special_value as result FROM tableA a

Collect metadata about SQL query › Responses

The result of the scan.

  • columnsobject[] · required

    Array of columns with types.

  • dataPreviewarray[]

    Array of rows where each row is another array of string values.

POST /api/v1/actions/dataSources/{dataSourceId}/scanSql
Available DriversData source files import