Como trocar dialetos SQL

Neste tópico, você aprenderá a definir o dialeto de consulta ao consultar dados do BigQuery. É possível usar os dialetos SQL padrão ou legado.

Para saber como começar a consultar dados usando a IU da Web do BigQuery, consulte o Guia de início rápido sobre o uso da IU da Web.

Para saber como começar a consultar dados usando a ferramenta de linha de comando bq, consulte o Guia de início rápido sobre o uso da ferramenta de linha de comando bq.

Como mudar do dialeto padrão

A interface usada para consultar os dados determina qual dialeto de consulta é o padrão:

  • No Console do Cloud e nas bibliotecas de cliente, o SQL padrão é o padrão.
  • Na versão clássica da IU da Web do BigQuery, na ferramenta de linha de comando bq e na API REST, o SQL legado é o padrão.

Para mudar para um dialeto diferente:

Console

O dialeto padrão do Console do Cloud é o SQL padrão. Para alterar o dialeto para SQL legado, faça o seguinte:

  1. Se necessário, clique em Escrever nova consulta para abrir a janela do editor de consultas.

  2. Abaixo do editor de consultas, clique em Mais > Configurações de consulta.

  3. Clique em Opções avançadas.

  4. Na seção Configurações extras, clique em Legado para Dialeto SQL. Isso define a opção de SQL legado para essa consulta. Ao clicar em Escrever nova consulta para criar uma nova consulta, será preciso selecionar a opção "SQL legado" novamente.

IU clássica

O dialeto padrão para a IU da Web clássica do BigQuery é o SQL legado. Para alterar o dialeto para o SQL padrão, faça o seguinte:

  1. Na IU da Web clássica do BigQuery, clique em Escrever consulta.

  2. Clique em Mostrar opções.

  3. Desmarque a caixa Usar SQL legado para o Dialeto SQL. Isso define a opção de SQL padrão enquanto o editor de consultas estiver aberto. Se você fechar o editor de consultas e abri-lo novamente, será necessário desmarcar essa opção outra vez.

CLI

O dialeto de consulta padrão na ferramenta de linha de comando bq é o SQL legado. Para alternar para o dialeto SQL padrão, adicione a sinalização --use_legacy_sql=false ou --nouse_legacy_sql à sua instrução de linha de comando.

Por exemplo:

bq query \
--use_legacy_sql=false \
'SELECT
  word
FROM
  `bigquery-public-data.samples.shakespeare`'

C#

Antes de testar esta amostra, siga as instruções de configuração do C# no Guia de início rápido do BigQuery – Como usar bibliotecas de cliente. Para mais informações, consulte a documentação de Referência da API BigQuery C# (em inglês).

Por padrão, a execução de uma consulta usa o SQL padrão.


using Google.Cloud.BigQuery.V2;
using System;

public class BigQueryQuery
{
    public void Query(
        string projectId = "your-project-id"
    )
    {
        BigQueryClient client = BigQueryClient.Create(projectId);
        string query = @"
            SELECT name FROM `bigquery-public-data.usa_names.usa_1910_2013`
            WHERE state = 'TX'
            LIMIT 100";
        BigQueryJob job = client.CreateQueryJob(
            sql: query,
            parameters: null,
            options: new QueryOptions { UseQueryCache = false });
        // Wait for the job to complete.
        job.PollUntilCompleted();
        // Display the results
        foreach (BigQueryRow row in client.GetQueryResults(job.Reference))
        {
            Console.WriteLine($"{row["name"]}");
        }
    }
}

Como usar o SQL legado

Para usar o SQL legado ao executar consultas, defina o parâmetro `UseLegacySql` como "true".


using Google.Cloud.BigQuery.V2;
using System;

public class BigQueryQueryLegacy
{
    public void QueryLegacy(
        string projectId = "your-project-id"
    )
    {
        BigQueryClient client = BigQueryClient.Create(projectId);
        string query = @"
            SELECT name FROM [bigquery-public-data:usa_names.usa_1910_2013]
            WHERE state = 'TX'
            LIMIT 100";
        BigQueryJob job = client.CreateQueryJob(
            sql: query,
            parameters: null,
            options: new QueryOptions { UseLegacySql = true });
        // Wait for the job to complete.
        job.PollUntilCompleted();
        // Display the results
        foreach (BigQueryRow row in client.GetQueryResults(job.Reference))
        {
            Console.WriteLine($"{row["name"]}");
        }
    }
}

Go

Antes de testar esta amostra, siga as instruções de configuração do Go no Guia de início rápido do BigQuery: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de Referência da API BigQuery Go (em inglês).

Por padrão, a biblioteca de cliente do Go usa o SQL padrão.

import (
	"context"
	"fmt"
	"io"

	"cloud.google.com/go/bigquery"
	"google.golang.org/api/iterator"
)

// queryBasic demonstrates issuing a query and reading results.
func queryBasic(w io.Writer, projectID string) error {
	// projectID := "my-project-id"
	ctx := context.Background()
	client, err := bigquery.NewClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("bigquery.NewClient: %v", err)
	}

	q := client.Query(
		"SELECT name FROM `bigquery-public-data.usa_names.usa_1910_2013` " +
			"WHERE state = \"TX\" " +
			"LIMIT 100")
	// Location must match that of the dataset(s) referenced in the query.
	q.Location = "US"
	// Run the query and print results when the query job is completed.
	job, err := q.Run(ctx)
	if err != nil {
		return err
	}
	status, err := job.Wait(ctx)
	if err != nil {
		return err
	}
	if err := status.Err(); err != nil {
		return err
	}
	it, err := job.Read(ctx)
	for {
		var row []bigquery.Value
		err := it.Next(&row)
		if err == iterator.Done {
			break
		}
		if err != nil {
			return err
		}
		fmt.Fprintln(w, row)
	}
	return nil
}

Como usar o SQL legado

Para alternar uma consulta para legado, use a property UseLegacySQL na configuração da consulta.

import (
	"context"
	"fmt"
	"io"

	"cloud.google.com/go/bigquery"
	"google.golang.org/api/iterator"
)

// queryLegacy demonstrates running a query using Legacy SQL.
func queryLegacy(w io.Writer, projectID, sqlString string) error {
	// projectID := "my-project-id"
	// sqlString = "SELECT 3 as somenum"
	ctx := context.Background()
	client, err := bigquery.NewClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("bigquery.NewClient: %v", err)
	}

	q := client.Query(sqlString)
	q.UseLegacySQL = true

	// Run the query and print results when the query job is completed.
	job, err := q.Run(ctx)
	if err != nil {
		return err
	}
	status, err := job.Wait(ctx)
	if err != nil {
		return err
	}
	if err := status.Err(); err != nil {
		return err
	}
	it, err := job.Read(ctx)
	for {
		var row []bigquery.Value
		err := it.Next(&row)
		if err == iterator.Done {
			break
		}
		if err != nil {
			return err
		}
		fmt.Fprintln(w, row)
	}
	return nil
}

Java

Antes de testar esta amostra, siga as instruções de configuração do Java no Guia de início rápido do BigQuery: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de Referência da API BigQuery Java (em inglês).

Por padrão, a biblioteca de cliente do Java usa o SQL padrão.

// BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService();
String query = "SELECT corpus FROM `bigquery-public-data.samples.shakespeare` GROUP BY corpus;";
QueryJobConfiguration queryConfig = QueryJobConfiguration.newBuilder(query).build();

// Print the results.
for (FieldValueList row : bigquery.query(queryConfig).iterateAll()) {
  for (FieldValue val : row) {
    System.out.printf("%s,", val.toString());
  }
  System.out.printf("\n");
}

Como usar o SQL legado

Para usar a sintaxe do SQL legado em um job de consulta, defina o parâmetro useLegacySql como true.

// BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService();
String query = "SELECT corpus FROM [bigquery-public-data:samples.shakespeare] GROUP BY corpus;";
QueryJobConfiguration queryConfig =
    // To use legacy SQL syntax, set useLegacySql to true.
    QueryJobConfiguration.newBuilder(query).setUseLegacySql(true).build();

// Print the results.
for (FieldValueList row : bigquery.query(queryConfig).iterateAll()) {
  for (FieldValue val : row) {
    System.out.printf("%s,", val.toString());
  }
  System.out.printf("\n");
}

Node.js

Antes de testar esta amostra, siga as instruções de configuração do Node.js no Guia de início rápido do BigQuery: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de Referência da API BigQuery Node.js.

Por padrão, a biblioteca de cliente do Node.js usa o SQL padrão.

// Import the Google Cloud client library using default credentials
const {BigQuery} = require('@google-cloud/bigquery');
const bigquery = new BigQuery();
async function query() {
  // Queries the U.S. given names dataset for the state of Texas.

  const query = `SELECT name
    FROM \`bigquery-public-data.usa_names.usa_1910_2013\`
    WHERE state = 'TX'
    LIMIT 100`;

  // For all options, see https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/query
  const options = {
    query: query,
    // Location must match that of the dataset(s) referenced in the query.
    location: 'US',
  };

  // Run the query as a job
  const [job] = await bigquery.createQueryJob(options);
  console.log(`Job ${job.id} started.`);

  // Wait for the query to finish
  const [rows] = await job.getQueryResults();

  // Print the results
  console.log('Rows:');
  rows.forEach(row => console.log(row));
}

Como usar o SQL legado

Para usar a sintaxe do SQL legado em um job de consulta, defina o parâmetro useLegacySql como true.

PHP

Antes de testar esta amostra, siga as instruções de configuração do PHP no guia de início rápido do BigQuery: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de Referência da API BigQuery PHP (em inglês).

Por padrão, a biblioteca de cliente do PHP usa o SQL padrão.

use Google\Cloud\BigQuery\BigQueryClient;
use Google\Cloud\Core\ExponentialBackoff;

/** Uncomment and populate these variables in your code */
// $projectId = 'The Google project ID';
// $query = 'SELECT id, view_count FROM `bigquery-public-data.stackoverflow.posts_questions`';

$bigQuery = new BigQueryClient([
    'projectId' => $projectId,
]);
$jobConfig = $bigQuery->query($query);
$job = $bigQuery->startQuery($jobConfig);

$backoff = new ExponentialBackoff(10);
$backoff->execute(function () use ($job) {
    print('Waiting for job to complete' . PHP_EOL);
    $job->reload();
    if (!$job->isComplete()) {
        throw new Exception('Job has not yet completed', 500);
    }
});
$queryResults = $job->queryResults();

$i = 0;
foreach ($queryResults as $row) {
    printf('--- Row %s ---' . PHP_EOL, ++$i);
    foreach ($row as $column => $value) {
        printf('%s: %s' . PHP_EOL, $column, json_encode($value));
    }
}
printf('Found %s row(s)' . PHP_EOL, $i);

Como usar o SQL legado

Para usar a sintaxe do SQL legado em um job de consulta, defina o parâmetro useLegacySql como true.

Python

Antes de testar esta amostra, siga as instruções de configuração do Python no Guia de início rápido do BigQuery: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API BigQuery Python.

Por padrão, a biblioteca de cliente do Python usa o SQL padrão.

# TODO(developer): Import the client library.
# from google.cloud import bigquery

# TODO(developer): Construct a BigQuery client object.
# client = bigquery.Client()

query = """
    SELECT name, SUM(number) as total_people
    FROM `bigquery-public-data.usa_names.usa_1910_2013`
    WHERE state = 'TX'
    GROUP BY name, state
    ORDER BY total_people DESC
    LIMIT 20
"""
query_job = client.query(query)  # Make an API request.

print("The query data:")
for row in query_job:
    # Row values can be accessed by field name or index.
    print("name={}, count={}".format(row[0], row["total_people"]))

Como usar o SQL legado

Para usar a sintaxe do SQL legado em um job de consulta, defina o parâmetro use_legacy_sql como True.

from google.cloud import bigquery

# TODO(developer): Construct a BigQuery client object.
# client = bigquery.Client()

query = (
    "SELECT name FROM [bigquery-public-data:usa_names.usa_1910_2013] "
    'WHERE state = "TX" '
    "LIMIT 100"
)

# Set use_legacy_sql to True to use legacy SQL syntax.
job_config = bigquery.QueryJobConfig(use_legacy_sql=True)

# Start the query, passing in the extra configuration.
query_job = client.query(query, job_config=job_config)  # Make an API request.

print("The query data:")
for row in query_job:
    print(row)

Ruby

Antes de testar este exemplo, siga as instruções de configuração do Ruby no Guia de início rápido do BigQuery: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de Referência da API BigQuery Ruby (em inglês).

Por padrão, a biblioteca de cliente do Ruby usa o SQL padrão.

require "google/cloud/bigquery"

def query
  bigquery = Google::Cloud::Bigquery.new
  sql = "SELECT name FROM `bigquery-public-data.usa_names.usa_1910_2013` " +
        "WHERE state = 'TX' " +
        "LIMIT 100"

  # Location must match that of the dataset(s) referenced in the query.
  results = bigquery.query sql do |config|
    config.location = "US"
  end

  results.each do |row|
    puts row.inspect
  end
end

Como usar um prefixo de consulta na IU

Também é possível definir o dialeto SQL no Console do Cloud ou na versão clássica da IU da Web ao incluir um prefixo de dialeto SQL como parte da consulta.

Os prefixos a seguir permitem que você defina o dialeto do SQL:

Prefixo Descrição
#legacySQL Executa a consulta com SQL legado
#standardSQL Executa a consulta com SQL padrão

Ao usar um prefixo de consulta no Console do Cloud, a opção dialeto SQL é desativada nas Configurações de consulta.

Na IU da Web clássica, ao usar um prefixo de consulta, ele precisa corresponder à opção de dialeto SQL. Por exemplo: se a opção Usar SQL legado for desmarcada na versão clássica da IU da Web, não será possível usar o prefixo #legacySQL em sua consulta.

Se você copiar e colar a consulta a seguir no Console do Cloud, por exemplo, o BigQuery vai executar a consulta usando SQL legado e ignorar a configuração padrão. A configuração padrão do Console do Cloud é o SQL padrão.

#legacySQL
SELECT
  weight_pounds, state, year, gestation_weeks
FROM
  [bigquery-public-data:samples.natality]
ORDER BY weight_pounds DESC
LIMIT 10;

Os prefixos de consulta #legacySQL e #standardSQL:

  • NÃO diferenciam maiúsculas de minúsculas;
  • precisam preceder a consulta;
  • precisam ser separados da consulta por um caractere de nova linha.

Algumas ferramentas de terceiros podem não ser compatíveis com esses prefixos se, por exemplo, modificarem o texto da consulta antes de enviá-lo ao BigQuery.

Como definir o SQL padrão como padrão para a ferramenta de linha de comando

É possível definir o SQL padrão como a sintaxe padrão para a ferramenta de linha de comando e o shell interativo editando o seguinte arquivo de configuração da ferramenta de linha de comando: .bigqueryrc.

Para mais informações sobre .bigqueryrc, consulte Como configurar valores padrão para sinalizações específicas de comando.

Para configurar --use_legacy_sql=false em .bigqueryrc:

  1. Abra .bigqueryrc em um editor de texto. Por padrão, .bigqueryrc deve estar em seu diretório de usuário. Por exemplo: $HOME/.bigqueryrc.

  2. Adicione o texto a seguir ao arquivo. Este exemplo define o SQL padrão como a sintaxe padrão para consultas e para o comando mk (usado ao criar uma visualização). Caso já tenha configurado valores padrão para sinalizações de comando query ou mk, não será preciso adicionar [query] ou [mk] novamente.

    [query]
    --use_legacy_sql=false
    
    [mk]
    --use_legacy_sql=false
    
  3. Salve e feche o arquivo.

  4. Se você estiver usando o shell interativo, precisará sair e reiniciar para que as mudanças sejam aplicadas.

Para mais informações sobre as sinalizações de linha de comando disponíveis, consulte a referência da ferramenta de linha de comando bq.