CreateSchema

Generates a schema file for a specified Salesforce table, defining field structure and types.

Generates a schema file (.rsd) for a Salesforce object.

To generate a schema file for an object:

    EXEC CreateSchema TableName='Account'

To generate a schema file with a custom table description:

    EXEC CreateSchema TableName='Account', TableDescription='My custom description'

To generate a schema file at a specific path:

    EXEC CreateSchema TableName='Account', FileName='C:\MyFolder\Account.rsd'

To return the schema as data instead of writing to disk:

    EXEC CreateSchema TableName='Account', WriteToFile='false'


Name	Type	Accepts Output Streams	Description
TableName	String	False	Name of the Salesforce object or table for which the schema should be generated. This is required.
TableDescription	String	False	Optional description for the table. If omitted, a default description is auto-generated by the driver.
WriteToFile	String	False	Specifies whether to save the generated schema to a file. Defaults to 'true'. Set to 'false' to return schema data via FileStream or FileData instead.
FileName	String	False	Name of the file to save the generated schema to. For example: 'Accounts.rsd'. Required if WriteToFile is 'true'.
FileStream	String	True	Optional output stream to write the schema content to, used when WriteToFile is 'false' and data should not be saved as a physical file.
SOQL	String	False	Deprecated. This input is only used to generate the schema (RSD) file for the specified table and has no effect on subsequent queries against the generated table. It will be removed in the next version.


Name	Type	Description
Result	String	Indicates whether the schema creation operation was successful ('Success') or failed ('Failure').
FileData	String	Base64-encoded content of the generated schema. Returned only when WriteToFile is 'false' and FileStream is not specified.
SchemaFile	String	Name or path of the generated schema file, confirming completion of the operation.

ADO.NET Provider for Salesforce