CreateSchema
Generates a schema file that defines the structure of a specified Box table or view for integration or analysis.
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 | Accepts Output Streams | Description |
| TableName | String | False | The name of the Box table or view for which the schema definition will be generated. |
| FileName | String | False | The full file path and name where the generated schema will be saved (for example, 'C:\\Users\\User\\Desktop\\Box\\CustomTable.rsd'). |
| FileStream | String | True | An output stream instance used to write schema file data when FileName is not provided. |
Result Set Columns
| Name | Type | Description |
| Result | String | Indicates whether the schema generation completed successfully or failed. |
| FileData | String | The generated schema file data encoded in Base64, returned when FileName and FileStream are not specified. |