nginstack

Class: DataSourceQuery

@nginstack/datasource/lib/DataSourceQuery~ DataSourceQuery

new DataSourceQuery(definition)

Realiza consultas em DataSources.

Parameters:
Name Type Description
definition !Record.<*, *> | number

Chave da configuração da consulta de DataSource ou objeto literal contendo as mesmas propriedades definidas na iVFS e capturadas através da chave.
See:
  • DataSourceQueryDef

Members

dataSource :!Record.<*, *>|number

A chave do script .ids ou objeto literal que contém as definições do DataSource.

Type:
  • !Record.<*, *> | number

dataSourceInstance

Obtém a instância da fonte de dados indicada por #dataSource ou #dataSourceKey. Essa instância será criada uma única vez, sob demanda.

dataSourceKey :number

A chave do script .ids que contém as definições do DataSource.

Type:
  • number
Deprecated:
  • Use #dataSource

<nullable> help :string

A ajuda associada ao DataSourceQuery.

Type:
  • string

<nullable> orderBy :string

Os nomes das colunas pelas quais a consulta deve ser ordenada, separados por ponto-e-vírgula. Para ordenar uma coluna em ordem descendente, utilize um sinal negativo ('-') precedendo o nome da coluna. Esta propriedade é utilizada apenas para o DataSourceVisualization, prefira o uso dela na definição da visualização.

Type:
  • string
Deprecated:
  • Yes

Methods

createColumns(columns)

Wrapper para criar o objeto de colunas a ser exibido após execução do DataSource.

Parameters:
Name Type Description
columns Array.<Object>

Array de objetos literais de colunas que serão processadas para gerar o objeto de colunas. Cada coluna é um objeto literal que segue as definições de DataSourceQueryColumnDef.

createFilters(filters)

Wrapper para criar o objeto de filtros a ser utilizado no DataSource.

Parameters:
Name Type Description
filters Array.<Object>

Array de objetos literais de filtros que serão processados para gerar o objeto de filtros. Cada filtro é um objeto literal que segue as definições de DataSourceQueryFilterDef.

execute(filters, columns)

Executa a consulta do DataSource.

Parameters:
Name Type Description
filters Array

Vetor de filtros do DataSource. Cada filtro é um objeto literal que segue as definições de DataSourceQueryFilterDef.
columns Array

Vetor de colunas do DataSource. Cada coluna é um objeto literal que segue as definições de DataSourceQueryColumnDef.
Returns:

O dataSet gerado pela consulta do DataSource.

Type
DataSet