JDBC Driver for Cloudant

Build 22.0.8462


Creates a schema definition of a table in Cloudant. Control column discovery with FlattenObjects, FlattenArrays, TypeDetectionScheme, and RowScanDepth.


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.


Name Type Required Accepts Output Streams Description
TableName String True False The name of the table.
FileName String False False The full file path and name of the schema to generate. If not set, the FileData output is used instead. Ex : 'C:\\Users\\User\\Desktop\\Cloudant\\sheet.rsd'
SimplifyNames String False False Whether to output simple names for columns or not. Default is to simplify.
FileStream String False True An instance of an output stream where file data is written to. Only used if FileName is not set.

Result Set Columns

Name Type Description
Result String Whether or not the schema was successfully downloaded.
FileData String The generated schema encoded in Base64. Only returned if FileName or FileStream is not set.

Copyright (c) 2023 CData Software, Inc. - All rights reserved.
Build 22.0.8462