17.6. columnsMetadata

Allows to fetch column metadata of a given table.

Here, datasource is an object resolver query that returns exactly one datasource. Refer to Section 13.5. Object Resolver for more information on object resolver queries.

The following example prints the metadata of the ''T_AGG_CUSTOMER'' table in the Datasource with id 123:

columnsMetadata id:DatasourceDefinition:123 T_AGG_CUSTOMER

The default metadata printed is the following:

  • COLUMN_NAME
  • TYPE_NAME
  • COLUMN_SIZE
  • DECIMAL_DIGITS
  • ORDINAL_POSITION
  • IS_NULLABLE
  • IS_AUTOINCREMENT

Metadata documentation of the columns above can be found here: https://docs.oracle.com/en/java/javase/11/docs/api/java.sql/java/sql/DatabaseMetaData.html#getColumns(java.lang.String,java.lang.String,java.lang.String,java.lang.String).

You may append, additionally to the default columns listed above, any number of the available metadata columns by passing them as arguments. E.g. you may choose to append TABLE_SCHEM and CHAR_OCTET_LENGTH as such:

Note that you can use the >{}>{}> operator for sending the command results to a given datasink. This may be useful for long command outputs for better result analysis. You can also use > for new file creation or >{}> for file append. Details of all terminal operators can be found in Chapter 16. Terminal Operators.

columnsMetadata id:DatasourceDefinition:123 T_AGG_CUSTOMER TABLE_SCHEM CHAR_OCTET_LENGTH

Use: columnsMetadata datasource table [column] [column...]