Cmdlets for Azure Cosmos DB

Build 24.0.9060

CreateSchema

Creates a schema file for the collection.

CreateSchema

Creates a local schema file (.rsd) from an existing table or view in the data model.

The schema file is created in the directory set in the Location connection property when this procedure is executed. You can edit the file to include or exclude columns, rename columns, or adjust column datatypes.

The cmdlet checks the Location to determine if the names of any .rsd files match a table or view in the data model. If there is a duplicate, the schema file will take precedence over the default instance of this table in the data model. If a schema file is present in Location that does not match an existing table or view, a new table or view entry is added to the data model of the cmdlet.

Input

Name Type Description
SchemaName String The schema of the collection.
TableName String The name of the collection.
FileName String The full file path and name of the schema to generate. If not set, the FileData output is used instead.

Result Set Columns

Name Type Description
Result String Returns Success or Failure.
FileData String The generated schema encoded in Base64. Only returned if FileName is not set.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060