.create tables command

  • Article

Creates new empty tables as a bulk operation.

The command must run in the context of a specific database.

Permissions

You must have at least Database User permissions to run this command.

Syntax

.create tables tableName1 (columnName:columnType [, ...]) [, tableName2 (columnName:columnType [, ...]) ... ] [with (propertyName = propertyValue [, ...])]

Learn more about syntax conventions.

Parameters

Name Type Required Description
tableName string ✔️ The name of the table to create.
columnName, columnType string ✔️ The name of a column mapped to the type of data in that column. The list of mappings defines the output column schema.
propertyName, propertyValue string A comma-separated list of key-value property pairs. See supported properties.

Supported properties

Name Type Description
docstring string Free text describing the entity to be added. This string is presented in various UX settings next to the entity names.
folder string The name of the folder to add to the table.

Note

If one or more tables with the same (case-sensitive) names as the specified tables already exist in the context of the database, the command returns success without changing the existing tables, even in the following scenarios:

  • The specified schema doesn't match the schema of an existing table
  • The folder or docstring parameters are specified with values different from the ones set in the existing tables

Any specified tables that don't exist are created.

Example

.create tables 
  MyLogs (Level:string, Timestamp:datetime, UserId:string, TraceId:string, Message:string, ProcessId:int32),
  MyUsers (UserId:string, Name:string)