CreateSchema
Creates a schema definition of a table in Couchbase. Results may change depending of the value of FlattenObjects, FlattenArrays, and TypeDetectionScheme.
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 driver 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 driver.
Input
| Name | Type | Required | Accepts Output Streams | Description |
| TableName | String | True | False | The name of the table. |
| FileName | String | False | False | The full file path and name of the schema to generate. Ex : 'C:\\Users\\User\\Desktop\\Couchbase\\sheet.rsd' |
| Overwrite | String | False | False | Will delete any existing schema file for this table. |
| FileStream | String | False | True | Stream to write the schema to. Only used if FileName is not provided. |
Result Set Columns
| Name | Type | Description |
| Result | String | Whether or not the schema was successfully built. |
| FileData | String | The content of the schema encoded as base64. Only returned if the FileName and FileStream are not provided. |