Column Properties

General

The following table lists and describes the column properties that are available in the Design View for all NoSQL data stores. The properties are listed in alphabetical order. Only writable properties can be edited.

Property Name Description Writable

Column #

A unique identifier for the column in the schema definition.

No

Foreign Key Column

A Boolean indicating whether the column contains foreign key values.

No

Hide Column

A Boolean indicating whether the column displays in ODBC and JDBC applications.

Yes

Primary Key Column

A Boolean indicating whether the column contains primary key values.

No

Source Name

The column name that is used in the NoSQL data store.

Yes

Source Type

The NoSQL data type that the column is mapped to in the NoSQL data store.

Yes

SQL Name

The column name that is used in SQL operations.

Yes

SQL Type

The SQL data type that the column is mapped to for SQL operations.

Yes

User Generated Column

A Boolean indicating whether the column was manually created through the Add Column or Move to Parent options in the Schema Editor. User-generated columns can be deleted.

Note:

The Move to Parent option is not supported for Couchbase and DocumentDB.

No

Couchbase

The following is an additional column property that is available when you work with Couchbase data stores. Writable properties can be edited.

Property Name Description Writable

Precision

The precision for fractional seconds in TIME and TIMESTAMP data. This value indicates the number of digits that exist to the right of the decimal in the seconds component of TIME and TIMESTAMP data.

This property does not affect data that is not of type TIME or TIMESTAMP.

Yes

DocumentDB

The following table lists and describes additional column properties that are available when you work with DocumentDB data stores. The properties are listed in alphabetical order. Only writable properties can be edited.

Property Name Description Writable

SQL Length

The maximum number of characters that the column can contain.

Yes

Precision

The number of digits in numeric data.

This property does not affect non-numeric data directly, but it is used if the data is converted to a numeric type.

Yes

Scale

The number of digits to the right of the decimal in numeric data.

This property does not affect non-numeric data directly, but it is used if the data is converted to a numeric type.

Yes

DynamoDB

The following table lists and describes additional column properties that are available when you work with DynamoDB data stores. The properties are listed in alphabetical order. Only writable properties can be edited.

Property Name Description Writable

Column Type

An identifier for the type of data that the column contains:

  • Data indicates that the column contains raw data values.
  • Index indicates that the column contains index values for lists.
  • Set indicates that the column contains data values from a set.

Yes

Length

The maximum number of characters that the column can contain.

Note:

If you connect using Simba DynamoDB JDBC Connector version 1.1.3 or later, the StringColumnMaxLength connection property from the connector overrides this Length property for all String columns.

For more information about the StringColumnMaxLength property, see the Simba DynamoDB JDBC Connector Installation and Configuration Guide.

Yes

Precision

The number of digits in numeric data.

This property does not affect non-numeric data directly, but it is used if the data is converted to a numeric type.

Yes

Scale

The number of digits to the right of the decimal in numeric data.

This property does not affect non-numeric data directly, but it is used if the data is converted to a numeric type.

Yes

Write Permission

A value specifying whether the data in the column is writable:

  • Read Only indicates that the data in the column cannot be changed.
  • Write indicates that the data in the column can be changed using DML statements.

Yes

MongoDB

The following table lists and describes additional column properties that are available when you work with MongoDB data stores. The properties are listed in alphabetical order. Only writable properties can be edited.

Property Name Description Writable

Column Size

The maximum number of characters that the column can contain.

Yes

Key Type

An identifier for the type of data that the column contains:

  • DATA_COLUMN indicates that the column contains raw data values.
  • ID_COLUMN indicates that the column contains _id values, which are primary key values used specifically in MongoDB.
  • INDEX_COLUMN indicates that the column contains index values for arrays.

No

Nullable

A Boolean indicating whether the column can contain NULL values.

Yes

Precision

The number of digits in numeric data.

This property does not affect non-numeric data directly, but it is used if the data is converted to a numeric type.

Yes
Scale

The number of digits to the right of the decimal in numeric data.

This property does not affect non-numeric data directly, but it is used if the data is converted to a numeric type.

Yes