Skip to main content
Skip table of contents

CONFIG_DATATYPES

CONFIG_DATATYPES is a configuration package that is used to configure datatype mappings from source system DBMS to logical datatypes used in Agile Data Engine.


See also:


Usage

  1. Open the configuration package from Designer Package list

  2. Click Export package in the Actions tab.

  3. Click Download.

  4. Edit JSON file.

  5. Import edited JSON back to Designer with Import Package.

After a successful import, changes to the configuration package have been applied to Designer only. It is recommended to deploy the same changes to Runtime environments as well.


Contents

Logical data type configuration

Logical data type configurations are managed inside a JSON array block named logicalDataTypes.

Key

Value type

Example

Description

logicalDatatype

String

INTEGER8

Logical type name

usesDataLength

Boolean

false

Whether the logical type uses data length or not. Supported values are 'true' and 'false'.

usesPrecisionMetadata

Boolean

false

Whether the logical type uses precision or not. Supported values are 'true' and 'false'.

usesScale

Boolean

false

Whether the logical type uses a scale or not. Supported values are 'true' and 'false'.

You can add a new logical data type or update the contents of an existing logical data type.

Example: Logical Data Type Configuration

JSON
"logicalDataTypes": [
  ...
  {
    "logicalDatatype": "INTEGER8",
    "usesDataLength": false,
    "usesPrecisionMetadata": false,
    "usesScale": false
  }
  ...
]

If an existing logical data type needs to be deleted, simply remove it from the set of values before importing the configuration package.


DW logical data type configuration

DW logical data type configurations are managed inside the JSON array block named dwLogicalDatatypes.

Key

Value type

Example

Description

logicalDatatype

String

VARCHAR

DW logical type name

usesDataLength

String

Y

Whether the logical data type uses data length or not. Supported values are 'Y' and 'N'.

usesPrecisionMetadata

String

N

Whether the logical data type uses precision or not. Supported values are 'Y' and 'N'.

usesScale

String

N

Whether the logical data type uses a scale or not. Supported values are 'Y' and 'N'.

You can add a new DW logical data type or update the contents of an existing DW logical data type.

Example: DW Logical Data Type configuration

JSON
"dwLogicalDatatypes": [
  ...
  {
    "logicalDatatype": "VARCHAR",
    "usesDataLength": "Y",
    "usesPrecisionMetadata": "N",
    "usesScale": "N"
  }
  ...
]

If an existing DW logical data type needs to be deleted, simply remove it from the set of values before importing the configuration package.


DW physical data type configuration

DW physical data type configurations are managed inside the JSON array block named dwPhysicalDatatypes.

Key

Value type

Example

Description

physicalDatatypeId

String

a9107d12-1ada-0794-bd93-43a3d8172c83

UUID. Can be generated with online tools, such as UUID Generator.

dbmsProduct

String

REDSHIFT

DBMS product

physicalDatatype

String

BIGINT

Physical data type

logicalDatatype

String

INTEGER8

Logical data type

You can add a new DW physical data type or update the contents of an existing DW physical data type.

Example: DW Physical Data Type configuration

JSON
"dwPhysicalDatatypes": [
  ...
  {
    "physicalDatatypeId": "a9107d12-1ada-0794-bd93-43a3d8172c83",
    "dbmsProduct": "REDSHIFT",
    "physicalDatatype": "BIGINT",
    "logicalDatatype": "INTEGER8"
  }
  ...
]

If an existing DW physical data type needs to be deleted, simply remove it from the set of values before importing the configuration package.


DW physical data type to logical configuration

DW physical data type to logical configurations are managed inside the JSON array block named dwPhysicalDatatypeToLogicals.

Key

Value type

Example

Description

physicalDatatypeToLogicalId

String

2e7f77cc-4150-2ad8-c276-1d9a012a3940

UUID. Can be generated with online tools, such as UUID Generator.

dbmsProduct

String

MS_SQL_DW

DBMS product

physicalDatatype

String

BIGINT

Physical data type

logicalDatatype

JSON String

---

For more information follow the JSON format of the DW Logical Data Type Configuration section above.

defaultPrecision

Integer

null

Optional: Default precision of the data type

defaultScale

Integer

null

Optional: Default scale of the data type

defaultLength

Integer

null

Optional: Default length of the data type

You can add a new DW physical data type to logical or update the contents of an existing DW physical data type to logical.

Example: DW Physical Datatype To Logical configuration

JSON

"dwPhysicalDatatypeToLogicals": [
  ...
  {
    "physicalDatatypeToLogicalId": "2e7f77cc-4150-2ad8-c276-1d9a012a3940",
    "dbmsProduct": "MS_SQL_DW",
    "physicalDatatype": "BIGINT",
    "logicalDatatype": {
      "logicalDatatype": "INTEGER8",
      "usesDataLength": "N",
      "usesPrecisionMetadata": "N",
      "usesScale": "N"
    },
    "defaultPrecision": null,
    "defaultScale": null,
    "defaultLength": null
  }
  ...
]

If an existing DW physical data type to logical needs to be deleted, simply remove it from the set of values before importing the configuration package.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.