Class: TableQueryBuilder
dg.TableQueryBuilder
Table query builder that works with database tables
Constructors
constructor
• new TableQueryBuilder(dart)
Constructs
TableQueryBuilder
Parameters
| Name | Type |
|---|---|
dart | any |
Defined in
Properties
dart
• dart: any
Defined in
Methods
build
▸ build(): TableQuery
Builds a query
Returns
Defined in
groupBy
▸ groupBy(fields): TableQueryBuilder
Groups rows that have the same values into summary values
Parameters
| Name | Type | Description |
|---|---|---|
fields | string[] | Array of fields to group by |
Returns
Defined in
limit
▸ limit(n): TableQueryBuilder
Selects limited number of records
Parameters
| Name | Type | Description |
|---|---|---|
n | number | Number of records to select |
Returns
Defined in
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
| Name | Type | Description |
|---|---|---|
fields | string[] | Array of fields to pivot on |
Returns
Defined in
select
▸ select(fields): TableQueryBuilder
Selects specified fields of the table
Parameters
| Name | Type | Description |
|---|---|---|
fields | string[] | Array of fields to select |
Returns
Defined in
selectAll
▸ selectAll(): TableQueryBuilder
Selects all fields of the table
Returns
Defined in
sortBy
▸ sortBy(field, asc?): TableQueryBuilder
Sorts results in ascending or descending order
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
field | string | undefined | Field to sort based on |
asc | boolean | true | Sort in ascending order |
Returns
Defined in
where
▸ where(field, pattern): TableQueryBuilder
Adds a where clause to the query
Parameters
| Name | Type | Description |
|---|---|---|
field | string | Field name |
pattern | string | Pattern to test field values against |
Returns
Defined in
from
▸ Static from(table): TableQueryBuilder
Creates TableQueryBuilder from table name
Parameters
| Name | Type | Description |
|---|---|---|
table | string | Table name |
Returns
Defined in
fromTable
▸ Static fromTable(table): TableQueryBuilder
Creates TableQueryBuilder from TableInfo
Parameters
| Name | Type | Description |
|---|---|---|
table | TableInfo | TableInfo object |