What is a Schema File in DataStage?


As a developer you always define the columns and their datatypes in ‘Column’ tab in each stage.

Do you know, you have another way to define columns other than columns tab?

Schemas are an alternative way to specify column definitions for the data used by parallel jobs.

As you know, by default, most parallel job stages take their meta data from the Columns tab, which contains table definitions, supplemented, where necessary by format information from the Format tab.

For some stages, you can specify a property that causes the stage to take its meta data from the specified schema file instead.

Read also: Difference between link sort and sort stage

Some stages also allow us to specify a partial schema. This allows you to define only those columns that a particular stage is processing and ignore the rest of columns.

The schema file is a plain text file. And it is preferable to save it with ‘.schema’ extension, so that you can identify them easily in file system.

Schema file format:

A schema contains a record (or row) definition. This describes each column (or field) that will be encountered within the record, giving column name and data type. The following is an example record schema:

record (
address:nullable string[255];

The line breaks are there for ease of reading, if you want you can omit these if you were defining a partial schema, for example


is a valid schema.

The format of each line describing a column is:


column_name: This is the name that identifies the column. Names must start with a letter or an underscore (_), and can contain only alphanumeric or underscore characters. The name is not case sensitive.

nullability: You can optionally specify whether a column is allowed to contain a null value, or whether this would be viewed as invalid. If the column can be null, insert the word ’nullable’. By default columns are not nullable.

You can also include ’nullable’ at record level to specify that all columns are nullable, then override the setting for individual columns by specifying ‘not nullable’. For example:

record nullable (
name:not nullable string[255];

datatype: This is the datatype of the column. This uses the internal data types but not SQL data types as used on Columns tabs in stage editors.

You can include comments in schema definition files. A comment is started by a double slash //, and ended by a newline.

You should always ensure that Runtime Column Propagation is turned on if you want to use schema files to define column meta data.

Read also: How FIELD Function Works in DataStage?

The example schema corresponds to the following table definition as specified on a Columns tab of a stage editor:




One Response

  1. Gopal Gupta December 18, 2018

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.

%d bloggers like this: