CreateSchema
Generates a schema definition file for a specified table or view. This stored procedure supports metadata export and integration tooling.
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 connector 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 connector.
Input
| Name | Type | Description |
| TableName | String | The stored procedure input parameter that specifies the name of the table or view for which a schema file is generated. This parameter is required. Specify the table or view name exactly as it appears in SugarCRM (for example, 'Accounts'). |
| FileName | String | The stored procedure input parameter that specifies the full file path and target file name for the generated schema output. This parameter is used when you want the schema written directly to a file (for example, 'C:/Users/Public/Desktop/Accounts.rsd'). |
Result Set Columns
| Name | Type | Description |
| Result | String | A stored procedure output parameter that returns a value of 'Success' when the schema generation operation completes successfully. It returns a value of 'Failure' when the process is unable to complete, which allows calling systems to evaluate execution state. |
| FileData | String | The stored procedure output parameter that returns the generated schema data as a Base64-encoded value when neither the FileName nor the FileStream parameter is specified. This parameter enables retrieval of schema content in contexts where direct file writing is not possible. |