CreateSchema
Creates a schema file for the collection.
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 | Accepts Output Streams | Description |
| TableName | String | False | The name of the table. |
| Format | String | False | The format of the returned data
The allowed values are XML, JSON, CSV. |
| URI | String | False | The Uniform Resource Identifier (URI) of the XML resource. |
| XPath | String | False | For XML/JSON: The XPath of an element that repeats at the same height within the document (used to split the document into multiple rows). |
| FileLocation | String | False | The folder path where the generated schema file will be stored. When specified the TableName will be used as the schema file name. |
| FileName | String | False | The complete schema file name of the generated schema. This input takes precedence over FileLocation. |
| FileStream | String | True | Stream to write the schema to. Only used if FileName/FileLocation are not provided. |
| Method | String | False | The HTTP method to use when retrieving data.
The default value is GET. |
| ContentType | String | False | The Content-Type header to send with PostData, if any is provided. |
| Data | String | False | The data to send in the HTTP request body. |
Result Set Columns
| Name | Type | Description |
| Result | String | Returns Success or Failure. |
| FileData | String | The content of the schema encoded as base64. Only returned if FileName, FileLocation and FileStream are not provided. |
Creates a schema file for the collection.
Input
| Name | Type | Description |
| TableName | String | The name of the collection and also the name of the schema (RSD) file. |
| Format | String | The format of the returned data
The allowed values are XML, JSON, CSV. |
| URI | String | The Uniform Resource Identifier (URI) of the RESTful resource. |
| XPath | String | For XML/JSON: The XPath of an element that repeats at the same height within the document (used to split the document into multiple rows). |
| FileLocation | String | The folder path where the generated schema (RSD) file will be stored. When specified the TableName will be used as the schema file name. |
| FileName | String | The complete schema (RSD) file name of the generated schema. This input takes precedence of FileLocation. |
| Method | String | The HTTP method to use when retrieving data.
The default value is GET. |
| ContentType | String | The Content-Type header to send with PostData, if any is provided. |
| Data | String | The data to send in the HTTP request body. |
Result Set Columns
| Name | Type | Description |
| Result | String | Returns Success or Failure. |
Creates a schema file for the collection.
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 | Accepts Output Streams | Description |
| TableName | String | False | The name of the table. |
| Format | String | False | The format of the returned data
The allowed values are XML, JSON, CSV. |
| URI | String | False | The Uniform Resource Identifier (URI) of the XML resource. |
| XPath | String | False | For XML/JSON: The XPath of an element that repeats at the same height within the document (used to split the document into multiple rows). |
| FileLocation | String | False | The folder path where the generated schema file will be stored. When specified the TableName will be used as the schema file name. |
| FileName | String | False | The complete schema file name of the generated schema. This input takes precedence over FileLocation. |
| FileStream | String | True | Stream to write the schema to. Only used if FileName/FileLocation are not provided. |
| Method | String | False | The HTTP method to use when retrieving data.
The default value is GET. |
| ContentType | String | False | The Content-Type header to send with PostData, if any is provided. |
| Data | String | False | The data to send in the HTTP request body. |
Result Set Columns
| Name | Type | Description |
| Result | String | Returns Success or Failure. |
| FileData | String | The content of the schema encoded as base64. Only returned if FileName, FileLocation and FileStream are not provided. |