Datasets - Execute Queries
Executa consultas DAX (Data Analysis Expressions) no conjunto de dados fornecido. O conjunto de dados deve residir em Meu workspace ou em outro workspace.
Os erros de consulta DAX resultarão em:
- Um erro de resposta, como
DAX query failure
. - Um código de status HTTP com falha (400).
Uma consulta que solicita mais de uma tabela ou mais do que o número permitido de linhas de tabela resultará em:
- Dados limitados sendo retornados.
- Um erro de resposta, como
More than one result table in a query
ouMore than {allowed number} rows in a query result
. - Um código http status bem-sucedido (200).
As colunas totalmente qualificadas na consulta serão retornadas com um nome totalmente qualificado, por exemplo, MyTable[MyColumn]
. As colunas renomeada ou criadas na consulta serão retornadas dentro do colchete, por exemplo, [MyNewColumn]
.
Permissões
A configuração do locatário API REST Executar Consultas do Conjunto de Dados, encontrada em Configurações de integração, deve estar habilitada.
O usuário deve ter permissões de leitura e compilação do conjunto de dados. Para saber mais, confira Gerenciar permissão para acesso ao conjunto de dados.
Escopo necessário
Dataset.ReadWrite.All ou Dataset.Read.All
Limitações
- Não há suporte para conjuntos de dados hospedados em Azure Analysis Services ou que têm uma conexão dinâmica com um modelo de Azure Analysis Services local.
- Uma consulta por chamada à API.
- Uma solicitação de tabela por consulta.
- Máximo de 100.000 linhas ou 1.000.000 valores por consulta (o que for atingido primeiro). Por exemplo, se você consultar cinco colunas, poderá recuperar o máximo de 100.000 linhas. Se você consultar 20 colunas, poderá recuperar o máximo de 50.000 linhas (1 milhão dividido por 20).
- Máximo de 15 MB de dados por consulta. Depois que 15 MB for excedido, a linha atual será concluída, mas nenhuma linha adicional será gravada.
- Há um limite de 120 solicitações de consulta por minuto por usuário, independentemente do conjunto de dados consultado.
- Para usar entidades de serviço, verifique se a configuração de locatário do administrador Permitir que as entidades de serviço usem APIs do Power BI em Configurações do desenvolvedor está habilitada. No entanto, independentemente da configuração de locatário do administrador, não há suporte para entidades de serviço para conjuntos de dados com RLS por RLS limitações ou conjuntos de dados com SSO habilitado.
- No momento, há suporte apenas para consultas DAX. Não há suporte para consultas MDX e DMV.
POST https://api.powerbi.com/v1.0/myorg/datasets/{datasetId}/executeQueries
Parâmetros de URI
Nome | Em | Obrigatório | Tipo | Description |
---|---|---|---|---|
dataset
|
path | True |
string |
A ID do conjunto de dados |
Corpo da solicitação
Nome | Obrigatório | Tipo | Description |
---|---|---|---|
queries | True |
A lista de consultas de conjunto de dados a serem executadas |
|
impersonatedUserName |
string |
O UPN de um usuário a ser representado. Se o modelo não estiver habilitado para RLS, isso será ignorado. |
|
serializerSettings |
As configurações de serialização para o conjunto de resultados |
Respostas
Nome | Tipo | Description |
---|---|---|
200 OK |
OK |
Exemplos
Execute queries example
Sample Request
POST https://api.powerbi.com/v1.0/myorg/datasets/cfafbeb1-8037-4d0c-896e-a46fb27ff229/executeQueries
{
"queries": [
{
"query": "EVALUATE VALUES(MyTable)"
}
],
"serializerSettings": {
"includeNulls": true
},
"impersonatedUserName": "someuser@mycompany.com"
}
Sample Response
{
"results": [
{
"tables": [
{
"rows": [
{
"MyTable[Year]": 2010,
"MyTable[Quarter]": "Q1"
},
{
"MyTable[Year]": 2010,
"MyTable[Quarter]": "Q2"
},
{
"MyTable[Year]": 2011,
"MyTable[Quarter]": "Q1"
}
]
}
]
}
]
}
Definições
Nome | Description |
---|---|
Dataset |
Os detalhes de um erro, se estiverem presentes. |
Dataset |
Os detalhes do rótulo de proteção de informações, se houver, associados ao conjunto de dados. |
Dataset |
Uma consulta de conjunto de dados |
Dataset |
Os resultados de uma única consulta de conjunto de dados |
Dataset |
Uma solicitação para executar consultas em um conjunto de dados |
Dataset |
A resposta a uma solicitação de consultas de execução de conjunto de dados |
Dataset |
As configurações de serialização para os resultados de uma consulta de conjunto de dados |
Dataset |
Uma tabela de dados |
DatasetExecuteQueriesError
Os detalhes de um erro, se estiverem presentes.
Nome | Tipo | Description |
---|---|---|
code |
string |
O código associado ao erro |
message |
string |
A mensagem do erro. Se não estiver presente aqui, essas informações também serão encontradas no objeto de detalhes aninhado sob o objeto error. |
DatasetExecuteQueriesInformationProtectionLabel
Os detalhes do rótulo de proteção de informações, se houver, associados ao conjunto de dados.
Nome | Tipo | Description |
---|---|---|
id |
string |
O identificador (guid) do rótulo de proteção de informações |
name |
string |
O nome de exibição do rótulo de proteção de informações |
DatasetExecuteQueriesQuery
Uma consulta de conjunto de dados
Nome | Tipo | Description |
---|---|---|
query |
string |
A consulta DAX a ser executada |
DatasetExecuteQueriesQueryResult
Os resultados de uma única consulta de conjunto de dados
Nome | Tipo | Description |
---|---|---|
error |
Os detalhes de um erro, se estiverem presentes. |
|
tables |
Uma lista de dados de tabelas para uma consulta |
DatasetExecuteQueriesRequest
Uma solicitação para executar consultas em um conjunto de dados
Nome | Tipo | Description |
---|---|---|
impersonatedUserName |
string |
O UPN de um usuário a ser representado. Se o modelo não estiver habilitado para RLS, isso será ignorado. |
queries |
A lista de consultas de conjunto de dados a serem executadas |
|
serializerSettings |
As configurações de serialização para o conjunto de resultados |
DatasetExecuteQueriesResponse
A resposta a uma solicitação de consultas de execução de conjunto de dados
Nome | Tipo | Description |
---|---|---|
error |
Os detalhes de um erro, se estiverem presentes. |
|
informationProtectionLabel |
Os detalhes do rótulo de proteção de informações, se houver, associados ao conjunto de dados. |
|
results |
A lista de resultados, uma por consulta de entrada. |
DatasetExecuteQueriesSerializationSettings
As configurações de serialização para os resultados de uma consulta de conjunto de dados
Nome | Tipo | Description |
---|---|---|
includeNulls |
boolean |
Se valores nulos (em branco) devem ser incluídos no conjunto de resultados. Se não for especificado, o valor padrão será |
DatasetExecuteQueriesTableResult
Uma tabela de dados
Nome | Tipo | Description |
---|---|---|
error |
Os detalhes de um erro, se estiverem presentes. |
|
rows |
object[] |
Uma lista de linhas |