ADO.NET Provider for Salesforce

Build 24.0.9029

CreateSchema

Creates a schema file for the specified table.

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 for which to create a schema.
TableDescription String False An optional description of the table. If not provided, the driver automatically generates a default description.
WriteToFile String False Whether to write the contents of the generated schema to a file or not. The input defaults to true. Set it to false to write to FileStream or FileData.
FileName String False The filename of the schema to generate. Ex: 'Accounts.rsd'
FileStream String True An instance of an output stream where file data is written to. Only used if WriteToFile=false.

Result Set Columns

Name Type Description
Result String Returns Success or Failure.
FileData String The generated schema encoded in Base64. Only returned if WriteToFile=false and FileStream is not provided.
SchemaFile String The generated schema file.

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