GetFileTableFields method

Overview

Lists the fields of a table for a folder connection.

Parameters

Name	Description	Type
qConnectionId	Identifier of the connection. This parameter is mandatory.	String
qRelativePath	Path of the connection file This parameter is optional.	String
qDataFormat	Type of the file.	FileDataFormat
qTable	Name of the table This parameter must be set for XLS, XLSX, HTML and XML files.	String

Name	Description	Type
qType	Type of the file.	FileType
qLabel	One of: embedded labels (field names are present in the file) no labels explicit labels (for DIFfiles)	String
qQuote	One of: None (no quotes) MSQ (Modern Style Quoting) Standard (quotes " " or ' ' can be used, but only if they are the first and last non blank characters of a field value.) This property is used for delimited files.	String
qComment	String that marks the beginning of the comment line. Example: “#” or “//” The engine ignores the commented lines during the data load. This property is only used for delimited files.	String
qDelimiter	Information about the delimiter. This property is used for delimited files.	DelimiterInfo
qCodePage	Character set used in the file.	Integer
qHeaderSize	Size of the header. Example: If the header size is 2, the first two rows in the file are considered as header and not as data. The header can contain the field names.	Integer
qRecordSize	Record length. Each record (row of data) contains a number of columns with a fixed field size. This property is used for fixed record data files.	Integer
qTabSize	Number of spaces that one tab character represents in the table file. This property is used for fixed record data files.	Integer
qIgnoreEOF	Is set to true, the end-of-file character is not taken into account during reload. This property is used for delimited files and fixed record data files.	Boolean
qFixedWidthDelimiters	Positions of the field breaks in the table. This property is used for fixed record data files.	String

Recognized file formats are:

CSV for Delimited
FIX for Fixed Record
DIF for Data Interchange Format
EXCEL_BIFF for Microsoft Excel (XLS)
EXCEL_OOXML for Microsoft Excel (XLSX)
HTMLfor HTML
QVD for QVD file
XML for XML
QVX for QVX file
JSON for JSON format
KML for KML file

Name	Description	Type
qName	Name of the delimiter. Example: "Tab_DELIMITER"	String
qScriptCode	Representation of the delimiter value that is used in the script. Example: "'\t'"	String
qNumber	Delimiter character number used by the engine to determine how to separate the values.	Integer
qIsMultiple	Is set to true if multiple spaces are used to separate the values.	Boolean

Outputs

The following is returned in the output:

Name	Description	Type
qFields	List of the tables	Array of DataField
qFormatSpec	List of format specification items, within brackets. Examples of specification items: file type embedded labels, no labels table is <table name>	String

Name

Description

Type

qFields

List of the tables

Array of DataField

qFormatSpec

List of format specification items, within brackets.

Examples of specification items:

file type
embedded labels, no labels
table is <table name>

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

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

Learn more

List the fields in a table for a folder connection

Did this page help you?

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

Leave your feedback here