FireDAC Components for REST

Build 23.0.8804


Creates a schema file for the collection.


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 component 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 component.


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).
WriteToFile String False Whether to write to an output file or not. Defaults to true, must be set to false to write to FileStream or FileData.
FileName String False The complete schema file name of the generated schema.
FileStream String True Stream to write the schema to. Only used if WriteToFile=false.
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 WriteToFile=false and FileStream is not provided.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 23.0.8804