CreateSchema
Generates a schema file that defines the structure of data within an Excel resource, including table layouts, column types, and metadata. This is typically used to initialize or validate workbook content against a defined schema.
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 | Specifies the logical name of the Excel dataset to be exposed as a table, which also determines the name of the resulting schema file (.rsd). This name acts as both an identifier for the resource and the basis for schema generation. |
| URI | String | False | Provides the Uniform Resource Identifier (URI) pointing to the Excel data source. This input is deprecated, as the URI is now derived automatically from the TableName parameter. It remains for backward compatibility. |
| FileName | String | False | Defines the target name for the schema file to be generated, including the .rsd extension. The exact location is controlled by the Location connection property, which should point to the desired output directory. |
| FileStream | String | True | Represents a writable output stream where the generated schema content will be saved. This is used as an alternative to the FileName parameter when LocalFolderPath is not specified. Useful in environments where writing to disk is restricted. |
Result Set Columns
| Name | Type | Description |
| Result | String | Indicates the result of the schema creation process. It returns either Success if the operation completed without errors, or Failure if an issue was encountered during execution. |
| FileData | String | Contains the raw schema file data in binary form when the FileName input is not specified. This allows clients to handle the file contents directly in memory without writing to disk. |