GetDatabaseTableFields method

Overview

Lists the fields inside a table of a database for a ODBC, OLEDB or CUSTOM connection.

Name	Description	Type
qConnectionId	Identifier of the connection This parameter is mandatory.	String
qDatabase	Name of the database This parameter is optional. If qDatabase is not set then qOwner must be set.	String
qOwner	Owner of the database This parameter is optional. If qOwner is not set then qDatabase must be set.	String
qTable	Name of the table This parameter is mandatory.	String

The following is returned in the output:

Name	Description	Type
qFields	List of the fields.	Array of DataField

Name

Description

Type

qFields

List of the fields.

Name	Description	Type
qName	Name of the field.	String
qIsKey	Is set to true if the field is a primary key.	Boolean
qOriginalFieldName	Is shown for fixed records. qOriginalFieldName and qName are identical if no field names are used in the file. qOriginalFieldName differs from qName if embedded file names are used in the file.	String

Name

Description

Type

qName

Name of the field.

String

qIsKey

Is set to true if the field is a primary key.

Boolean

qOriginalFieldName

Is shown for fixed records.

qOriginalFieldName and qName are identical if no field names are used in the file.

qOriginalFieldName differs from qName if embedded file names are used in the file.

String

If you find any issues with this page or its content – a typo, a missing step, or a technical error – let us know how we can improve!