CreateSchema
Generates a schema file for a specified table or view. This stored procedure supports development and documentation workflows by exporting the structural definition of an entity.
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 provider 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 provider.
Input
| Name | Type | Required | Accepts Output Streams | Description |
| TableName | String | True | False | Specifies the name of the table or view that is used by the CreateSchema stored procedure. This input determines which schema definition the procedure retrieves and prepares for output. |
| FileName | String | False | False | Specifies the full file path and file name that the CreateSchema stored procedure uses to generate the schema output. This input directs the system to write the resulting schema file to the specified location. |
| FileStream | String | False | True | Represents the output-stream instance that is used to receive the schema content. This input is used when FileName input is not provided and allows the procedure to write schema data directly to the caller's stream. |
Result Set Columns
| Name | Type | Description |
| Result | String | Returns a value of 'true' when the CreateSchema stored procedure completes successfully. It returns a value of 'false' when the procedure encounters an error or cannot generate the schema output. |
| FileData | String | Represents the Base64-encoded schema content that is generated by the CreateSchema stored procedure. This output is returned when neither FileName input nor FileStream input is supplied, allowing the caller to retrieve schema data directly. |