TableQueryBuilder

Table query builder that works with database tables

Constructors

new TableQueryBuilder()

new TableQueryBuilder(dart): TableQueryBuilder

Parameters

Parameter	Type
dart	any

Returns

TableQueryBuilder

Constructs

TableQueryBuilder

Source

src/entities.ts:537

Properties

Property	Type
dart	any

Methods

avg()

avg(field, fieldAlias): TableQueryBuilder

Adds an aggregation that calculates average value for the specified column.

Parameters

Parameter	Type	Default value	Description
field	string	undefined	Column name.
fieldAlias	null | string	'avg'	Name of the resulting column. Default value is agg(colName).

Returns

TableQueryBuilder

Source

src/entities.ts:579

---

build()

build(): TableQuery

Builds a query

Returns

TableQuery

Source

src/entities.ts:746

---

count()

count(fieldAlias): TableQueryBuilder

Adds an aggregation that counts rows. Equivalent to count(*).

Parameters

Parameter	Type	Default value	Description
fieldAlias	string	'count'	Name of the resulting column. Default value is count.

Returns

TableQueryBuilder

Source

src/entities.ts:614

---

groupBy()

groupBy(fields): TableQueryBuilder

Groups rows that have the same values into summary values

Parameters

Parameter	Type	Description
fields	string[]	Array of fields to group by

Returns

TableQueryBuilder

Source

src/entities.ts:701

---

having()

having(field, pattern, columnType?): TableQueryBuilder

Adds a having clause to the query. Use only with groupBy

Parameters

Parameter	Type	Description
field	string	Field name. If you join to other tables use correct alias or table name as prefix, e.g. <table alias>.<field>
pattern	string	Pattern to test field values against
columnType?	"string" | "bigint" | "object" | "map" | "file" | "view" | "blob" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe" | "num" | "string_list" | "dataframe_list" | "cell" | "column" | "column_list" | "graphics" | "tablerowfiltercall" | "colfiltercall" | "bitset" | "dynamic" | "viewer" | "list" | "semantic_value" | "func" | "funccall" | "property" | "categorical" | "numerical" | "GridCellRenderArgs" | "element" | "TableView" | "User" | "Menu" | "Project" | "event_data" | "progressindicator" | "Credentials" | "ScriptEnvironment" | "Notebook"	Should be provided, if this builder wasn't created from TableInfo or alias is used. Defaults to TYPE.STRING

Returns

TableQueryBuilder

Source

src/entities.ts:727

---

innerJoin()

innerJoin(rightTable, leftTableKeys, rightTableKeys, rightTableAlias?, leftTable?): TableQueryBuilder

Performs inner join operation.

Parameters

Parameter	Type	Description
rightTable	string	{string}
leftTableKeys	string[]	{string[]}
rightTableKeys	string[]	{string[]}
rightTableAlias?	string	{string}
leftTable?	string	{string}

Returns

TableQueryBuilder

Source

src/entities.ts:682

---

join()

join(rightTable, joinType, leftTableKeys, rightTableKeys, rightTableAlias?, leftTable?): TableQueryBuilder

Performs join operation of main table or table specified in leftTable to table specified in rightTable. Specify joining fields of the main table (or table specified in leftTable) in leftTableKeys and joining fields of rightTable in rightTableKeys.

Parameters

Parameter	Type	Description
rightTable	string	{string}
joinType	"left" | "right" | "inner" | "outer"	{JoinType}
leftTableKeys	string[]	{string[]}
rightTableKeys	string[]	{string[]}
rightTableAlias?	string	{string} - use to specify desired alias for the joining table and apply this alias to fields specified in select.
leftTable?	string	{string}

Returns

TableQueryBuilder

Source

src/entities.ts:646

---

leftJoin()

leftJoin(rightTable, leftTableKeys, rightTableKeys, rightTableAlias?, leftTable?): TableQueryBuilder

Performs left join operation.

Parameters

Parameter	Type	Description
rightTable	string	{string}
leftTableKeys	string[]	{string[]}
rightTableKeys	string[]	{string[]}
rightTableAlias?	string	{string}
leftTable?	string	{string}

Returns

TableQueryBuilder

Source

src/entities.ts:658

---

limit()

limit(n): TableQueryBuilder

Selects limited number of records

Parameters

Parameter	Type	Description
n	number	Number of records to select

Returns

TableQueryBuilder

Source

src/entities.ts:742

---

max()

max(field, fieldAlias): TableQueryBuilder

Adds an aggregation that calculates maximum value for the specified column.

Parameters

Parameter	Type	Default value	Description
field	string	undefined	Column name.
fieldAlias	null | string	'max'	Name of the resulting column. Default value is agg(colName).

Returns

TableQueryBuilder

Source

src/entities.ts:597

---

min()

min(field, fieldAlias): TableQueryBuilder

Adds an aggregation that calculates minimum value for the specified column.

Parameters

Parameter	Type	Default value	Description
field	string	undefined	Column name.
fieldAlias	null | string	'min'	Name of the resulting column. Default value is agg(colName).

Returns

TableQueryBuilder

Source

src/entities.ts:588

---

nulls()

nulls(field, fieldAlias): TableQueryBuilder

Adds an aggregation that counts rows with null values

Parameters

Parameter	Type	Default value	Description
field	string	undefined	Column name.
fieldAlias	null | string	'nulls'	Name of the resulting column. Default value is agg(colName).

Returns

TableQueryBuilder

Source

src/entities.ts:631

---

outerJoin()

outerJoin(rightTable, leftTableKeys, rightTableKeys, rightTableAlias?, leftTable?): TableQueryBuilder

Performs outer join operation.

Parameters

Parameter	Type	Description
rightTable	string	{string}
leftTableKeys	string[]	{string[]}
rightTableKeys	string[]	{string[]}
rightTableAlias?	string	{string}
leftTable?	string	{string}

Returns

TableQueryBuilder

Source

src/entities.ts:694

---

pivotOn()

pivotOn(fields): TableQueryBuilder

Rotates a table-valued expression by turning the unique values from one column in the expression into multiple columns in the output

Parameters

Parameter	Type	Description
fields	string[]	Array of fields to pivot on

Returns

TableQueryBuilder

Source

src/entities.ts:709

---

rightJoin()

rightJoin(rightTable, leftTableKeys, rightTableKeys, rightTableAlias?, leftTable?): TableQueryBuilder

Performs right join operation.

Parameters

Parameter	Type	Description
rightTable	string	{string}
leftTableKeys	string[]	{string[]}
rightTableKeys	string[]	{string[]}
rightTableAlias?	string	{string}
leftTable?	string	{string}

Returns

TableQueryBuilder

Source

src/entities.ts:670

---

select()

select(fields): TableQueryBuilder

Selects specified fields of the table. All fields will be selected if not provided.

Parameters

Parameter	Type	Description
fields	string[]	Array of fields to select

Returns

TableQueryBuilder

Source

src/entities.ts:562

---

selectAggr()

selectAggr(type, field, fieldAlias): TableQueryBuilder

Performs aggregation

Parameters

Parameter	Type	Description
type	"values" | "max" | "key" | "min" | "sum" | "pivot" | "first" | "count" | "unique" | "nulls" | "med" | "avg" | "stdev" | "variance" | "skew" | "kurt" | "q1" | "q2" | "q3" | "#selected"	Aggregation type.
field	null | string	Column name.
fieldAlias	null | string	Name of the resulting column. Default value is agg(colName).

Returns

TableQueryBuilder

Source

src/entities.ts:570

---

selectAll()

selectAll(): TableQueryBuilder

Selects all fields of the table

Returns

TableQueryBuilder

Source

src/entities.ts:557

---

sortBy()

sortBy(field, asc): TableQueryBuilder

Sorts results in ascending or descending order

Parameters

Parameter	Type	Default value	Description
field	string	undefined	Field to sort based on
asc	boolean	true	Sort in ascending order

Returns

TableQueryBuilder

Source

src/entities.ts:735

---

sum()

sum(field, fieldAlias): TableQueryBuilder

Adds an aggregation that calculates sum of the values for the specified column.

Parameters

Parameter	Type	Default value	Description
field	string	undefined	Column name.
fieldAlias	null | string	'sum'	Name of the resulting column. Default value is agg(colName).

Returns

TableQueryBuilder

Source

src/entities.ts:606

---

valueCount()

valueCount(field, fieldAlias): TableQueryBuilder

Adds an aggregation that counts rows for the specified column. Equivalent to count(field).

Parameters

Parameter	Type	Default value	Description
field	string	undefined	Column name.
fieldAlias	string	'count'	Name of the resulting column. Default value is count.

Returns

TableQueryBuilder

Source

src/entities.ts:622

---

where()

where(field, pattern, columnType?): TableQueryBuilder

Adds a where clause to the query.

Parameters

Parameter	Type	Description
field	string	Field name. If you join to other tables use correct alias or table name as prefix, e.g. <table alias>.<field>
pattern	string	Pattern to test field values against
columnType?	"string" | "bigint" | "object" | "map" | "file" | "view" | "blob" | "int" | "double" | "bool" | "byte_array" | "datetime" | "qnum" | "dataframe" | "num" | "string_list" | "dataframe_list" | "cell" | "column" | "column_list" | "graphics" | "tablerowfiltercall" | "colfiltercall" | "bitset" | "dynamic" | "viewer" | "list" | "semantic_value" | "func" | "funccall" | "property" | "categorical" | "numerical" | "GridCellRenderArgs" | "element" | "TableView" | "User" | "Menu" | "Project" | "event_data" | "progressindicator" | "Credentials" | "ScriptEnvironment" | "Notebook"	Should be provided, if this builder wasn't created from TableInfo or alias is used. Defaults to TYPE.STRING

Returns

TableQueryBuilder

Source

src/entities.ts:718

---

from()

static from(table, connection?): TableQueryBuilder

Creates TableQueryBuilder from table name

Parameters

Parameter	Type	Description
table	string	Table name
connection?	string | DataConnection	DataConnection that TableQuery will use after the build. Can be passed lately directly to TableQuery.

Returns

TableQueryBuilder

Source

src/entities.ts:543

---

fromTable()

static fromTable(table): TableQueryBuilder

Creates TableQueryBuilder from TableInfo

Parameters

Parameter	Type	Description
table	TableInfo	TableInfo object

Returns

TableQueryBuilder

Source

src/entities.ts:551