Typedef

Static Public Summary
public	Change: Object A change indicating a modification to a schema or column.
public	Changes: Array An array of changes containing items of type Change
public	Column: Object A column describing a single property of data.
public	ColumnCreateChange: Object A change indicating a column has been created.
public	ColumnRemoveChange: Object A change indicating a column has been removed.
public	ColumnRenameChange: Object A change indicating a column has been renamed.
public	ColumnTypechangeChange: Object A change indicating the type of a column has changed.
public	DataInfo: Object A container for data that also includes information about the project and schema.
public	Item: Object An object containing actual data, the keys are the column names and the values are depending on the column type.
public	Project: Object A project
public	ProjectCreateChange: Object A change indicating a project has been created
public	ProjectRemoveChange: Object A change indicating a project has been removed
public	ProjectRenameChange: Object A change indicating a project has been renamed
public	ProjectTagChange: Object A change indicating a project has been tagged
public	Schema: Object A schema describing the properties of data.
public	SchemaCreateChange: Object A change indicating a schema has been created.
public	SchemaRemoveChange: Object A change indicating a schema has been removed.
public	SchemaRenameChange: Object A change indicating a schema has been renamed.
public	ValidationResult: Object A result of the validation containing errors when failed.

Static Public

public Change: Object source

A change indicating a modification to a schema or column.

Properties:

Name	Type	Attribute	Description
projectId	String		The id of the project that this change applies to
schemaId	String		The id of the schema that this change applies to
change	String		A string indicating the type of change, this can be any of: project.create project.rename project.remove project.tag schema.create schema.rename schema.remove column.create column.rename column.remove column.typechange

public Changes: Array source

An array of changes containing items of type Change

public Column: Object source

A column describing a single property of data.

Properties:

Name	Type	Attribute	Description
name	String		The name of the column
type	String		The type of the column

public ColumnCreateChange: Object source

A change indicating a column has been created.

Properties:

Name	Type	Attribute	Description
projectId	String		The id of the project that this change applies to
schemaId	String		The id of the schema that this change applies to
columnId	String		The id of the column that has been created
column	Schema		The column that has been created

public ColumnRemoveChange: Object source

A change indicating a column has been removed.

Properties:

Name	Type	Attribute	Description
projectId	String		The id of the project that this change applies to
schemaId	String		The id of the schema that this change applies to
columnId	String		The id of the column that has been removed
oldColumn	Column		The column that has been removed

public ColumnRenameChange: Object source

A change indicating a column has been renamed.

Properties:

Name	Type	Attribute	Description
projectId	String		The id of the project that this change applies to
schemaId	String		The id of the schema that this change applies to
columnId	String		The id of the column that has been renamed
name	String		The new name of the column
oldName	String		The old name of the column

public ColumnTypechangeChange: Object source

A change indicating the type of a column has changed.

Properties:

Name	Type	Attribute	Description
projectId	String		The id of the project that this change applies to
schemaId	String		The id of the schema that this change applies to
columnId	String		The id of the column that has changed
columnName	String		The name of the the column that has changed
type	String		The new type of the column
oldType	String		The old type of the column

public DataInfo: Object source

A container for data that also includes information about the project and schema.

Properties:

Name	Type	Attribute	Description
projectId	String		The id of the project
projectName	String		The name of the project
projectVersion	Number		The version of the project
schemaId	String		The id of the schema
schemaName	String		The name of the schema
item	Object		An object containing the data

public Item: Object source

An object containing actual data, the keys are the column names and the values are depending on the column type.

Properties:

Name	Type	Attribute	Description
value	*		Test

public Project: Object source

A project

Properties:

Name	Type	Attribute	Description
name	String
version	Number
schemas	Object		An object of schemas where the key is the unique id for the schema and the value is an object of type Schema

public ProjectCreateChange: Object source

A change indicating a project has been created

Properties:

Name	Type	Attribute	Description
projectId	String		The id of the project that has been created
project	Project		The project that has been created

public ProjectRemoveChange: Object source

A change indicating a project has been removed

Properties:

Name	Type	Attribute	Description
projectId	String		The id of the project that has been removed
oldProject	Project		The project that has been removed

public ProjectRenameChange: Object source

A change indicating a project has been renamed

Properties:

Name	Type	Attribute	Description
projectId	String		The id of the project that has been renamed
name	String		The new name for the project
oldName	String		The old name for the project

public ProjectTagChange: Object source

A change indicating a project has been tagged

Properties:

Name	Type	Attribute	Description
projectId	String		The id of the project that has been tagged
version	String		The new version for the project
oldVersion	String		The old version of the project

public Schema: Object source

A schema describing the properties of data.

Properties:

Name	Type	Attribute	Description
name	String		The name of the schema
primary	String \| Array		The id of the column, or an array of ids that indicate as the primary key
columns	Object		An object of columns where the key is the unique id for the column and the value is an object of type Column

public SchemaCreateChange: Object source

A change indicating a schema has been created.

Properties:

Name	Type	Attribute	Description
projectId	String		The id of the project that this change applies to
schemaId	String		The id of the schema that has been created
schema	Schema		The schema that has been created

public SchemaRemoveChange: Object source

A change indicating a schema has been removed.

Properties:

Name	Type	Attribute	Description
projectId	String		The id of the project that this change applies to
schemaId	String		The id of the schema that has been removed
oldSchema	Schema		The schema that has been removed

public SchemaRenameChange: Object source

A change indicating a schema has been renamed.

Properties:

Name	Type	Attribute	Description
projectId	String		The id of the project that this change applies to
schemaId	String		The id of the schema that has been renamed
name	String		The new name of the column
oldName	String		The old name of the column

public ValidationResult: Object source

A result of the validation containing errors when failed.

Properties:

Name	Type	Attribute	Description
success	Boolean		Whether the validation was successfull or not
errors	Array		An array of error objects