gsSQL Sheets Custom Function

TableFields

Fields from all tables.

Constructor

new TableFields()

Source:

Views.js, line 2308

Members

allFields

Source:

Views.js, line 2311

Properties:

Type	Description
Array.<TableField>

fieldNameMap

Source:

Views.js, line 2313

Properties:

Type	Description
Map.<String, TableField>

tableColumnMap

Source:

Views.js, line 2315

Properties:

Type	Description
Map.<String, TableField>

Methods

findTableField(tableName, tableColumn) → {TableField}

Description:

Quickly find field info for TABLE + COLUMN NUMBER (key of map)

Source:

Views.js, line 2408

Parameters:

Name	Type	Description
`tableName`	String	Table name to search for.
`tableColumn`	Number	Column number to search for.

Returns:

-located table info (null if not found).

Type: TableField

getColumnNames() → {Array.<String>}

Description:

Get SELECTED Field names sorted list of column number.

Source:

Views.js, line 2622

Returns:

Table field names

Type: Array.<String>

getColumnTitles(columnTableNameReplacement) → {Array.<String>}

Description:

Get column titles. If alias was set, that column would be the alias, otherwise it is column name.

Source:

Views.js, line 2634

Parameters:

Name	Type	Description
`columnTableNameReplacement`	String

Returns:

column titles

Type: Array.<String>

getConglomerateFieldCount() → {Number}

Description:

Counts the number of conglomerate field functions in SELECT field list.

Source:

Views.js, line 2747

Returns:

Number of conglomerate functions.

Type: Number

getFieldColumn(field) → {Number}

Description:

Get column number for field.

Source:

Views.js, line 2446

Parameters:

Name	Type	Description
`field`	String	field name

Returns:

column number in table for field (-1 if not found)

Type: Number

getFieldInfo(field) → {TableField}

Description:

Get field info.

Source:

Views.js, line 2427

Parameters:

Name	Type	Description
`field`	String	table column name to find

Returns:

table info (undefined if not found)

Type: TableField

getNextSelectColumnNumber() → {Number}

Description:

Find next available column number in selected field list.

Source:

Views.js, line 2581

Returns:

column number

Type: Number

getSelectFieldColumn(field) → {Number}

Description:

Get field column number.

Source:

Views.js, line 2456

Parameters:

Name	Type	Description
`field`	String	field name

Returns:

column number.

Type: Number

getSelectFields() → {Array.<TableField>}

Description:

Get a sorted list (by column number) of selected fields.

Source:

Views.js, line 2611

Returns:

selected fields

Type: Array.<TableField>

getTableInfo(field) → {Table}

Description:

Get table associated with field name.

Source:

Views.js, line 2436

Parameters:

Name	Type	Description
`field`	String	field name to search for

Returns:

associated table info (undefined if not found)

Type: Table

getTempSelectedColumnNumbers() → {Array.<Number>}

Description:

Return a list of temporary column numbers in select field list.

Source:

Views.js, line 2594

Returns:

sorted list of temp column numbers.

Type: Array.<Number>

hasField(field) → {Boolean}

Description:

Is this field in our map.

Source:

Views.js, line 2418

Parameters:

Name	Type	Description
`field`	String	field name

Returns:

found in map if true.

Type: Boolean

indexTableField(field, isPrimaryTable)

Description:

Set up mapping to quickly find field info - by all (alias) names, by table+column.

Source:

Views.js, line 2381

Parameters:

Name	Type	Default	Description
`field`	TableField		field info.
`isPrimaryTable`	Boolean	`false`	is this a field from the SELECT FROM TABLE.

loadVirtualFields(primaryTable, tableInfo)

Description:

Iterate through all table fields and create a list of these VirtualFields.

Source:

Views.js, line 2323

Parameters:

Name	Type	Description
`primaryTable`	String	primary FROM table name in select.
`tableInfo`	Map.<String, Table>	map of all loaded tables.

parseAstSelectField(selField) → {ParsedSelectField}

Description:

Parse SELECT field in AST (may include functions or calculations)

Source:

Views.js, line 2686

Parameters:

Name	Type	Description
`selField`	Object

Returns:

Type: ParsedSelectField

updateCalculatedAsSelected(selectedFieldParms)

Source:

Views.js, line 2543

Parameters:

Name	Type	Description
`selectedFieldParms`	SelectFieldParameters

updateColumnAsSelected(selectedFieldParms) → {void}

Source:

Views.js, line 2510

Parameters:

Name	Type	Description
`selectedFieldParms`	SelectFieldParameters

Returns:

Type: void

updateConstantAsSelected(selectedFieldParms)

Source:

Views.js, line 2562

Parameters:

Name	Type	Description
`selectedFieldParms`	SelectFieldParameters

updateDerivedTableVirtualFields(derivedTable)

Description:

Derived tables will cause an update to any TableField. It updates with a new column number and new table (derived) info.

Source:

Views.js, line 2658

Parameters:

Name	Type	Description
`derivedTable`	DerivedTable	derived table info.

updateSelectFieldList(astFields, nextColumnPosition, isTempField)

Description:

Updates internal SELECTED (returned in data) field list.

Source:

Views.js, line 2480

Parameters:

Name	Type	Description
`astFields`	Object	AST from SELECT
`nextColumnPosition`	Number
`isTempField`	Boolean

(static) getSelectCountModifiers(originalColumnName) → {Array.<String>}

Description:

Parse for any SELECT COUNT modifiers like 'DISTINCT' or 'ALL'.

Source:

Views.js, line 2715

Parameters:

Name	Type	Description
`originalColumnName`	String	column (e.g. 'distinct customer_id')

Returns:

[0] - parsed column name, [1] - count modifier

Type: Array.<String>

(static) sortPrimaryFields(fldA, fldB)

Description:

Sort function for table fields list.

Source:

Views.js, line 2362

Parameters:

Name	Type	Description
`fldA`	TableField
`fldB`	TableField