Referência da ferramenta de linha de comando

Neste documento, você encontra detalhes sobre os comandos e sinalizações da ferramenta de linha de comando bq. Para informações sobre como usar a ferramenta de linha de comando bq, consulte Como usar a ferramenta de linha de comando bq.

Sinalizações globais

Use as seguintes sinalizações globais com a ferramenta de linha de comando bq:

[OBSOLETO] Sinalizações de autorização da bq

As sinalizações de autorização bq se tornaram obsoletas. Para configurar a autorização da ferramenta de linha de comando bq, consulte Como autorizar ferramentas do SDK do Cloud.

--application_default_credential_file
Para mais informações, consulte Como configurar a autenticação para aplicativos de produção de servidor para servidor. O valor padrão é ''.
--credential_file
O nome de arquivo usado para armazenar o token OAuth. O valor padrão é $HOME/.bigquery.v2.token.
--service_account
Use o endereço de e-mail dessa conta de serviço para autorização. Por exemplo, 1234567890@developer.gserviceaccount.com. O valor padrão é ''.
--service_account_credential_file
O arquivo usado como armazenamento de credenciais para contas de serviço. Será necessário definir essa sinalização se você estiver usando uma conta de serviço.
--service_account_private_key_file
O arquivo que contém a chave privada da conta de serviço. Essa sinalização será obrigatória se --service_account for especificada. O valor padrão é ''.
--service_account_private_key_password
A senha da chave privada. A senha precisa corresponder à que você definiu na chave ao criá-la. O valor padrão é notasecret.
--use_gce_service_account
Ao executar em uma instância do Compute Engine, especifique essa sinalização para usar credenciais de conta de serviço em vez de credenciais armazenadas. Para mais informações, consulte Como criar e ativar contas de serviço para instâncias. O valor padrão é false.

Sinalizações globais da bq

--api
O endpoint da API a ser chamada. O valor padrão é https://www.googleapis.com.

--api_versionA versão da API a ser usada. O padrão é v2.

--apilog
Registre todas as solicitações e respostas de API no arquivo especificado por essa sinalização. Também é possível usar stdout e stderr. A especificação da string vazia ('') será direcionada para stdout.
--bigqueryrc
O caminho para o arquivo de configuração da ferramenta de linha de comando bq. O arquivo de configuração especifica novos padrões para qualquer sinalização e, para ser substituído, basta especificar a sinalização na linha de comando. Se a sinalização --bigqueryrc não for especificada, a variável de ambiente BIGQUERYRC será usada. Se não for especificada, o caminho ~/.bigqueryrc será usado. O valor padrão é $HOME/.bigqueryrc.
--ca_certificates_file
O local do seu arquivo de certificado de CA. O valor padrão é ''.
--dataset_id
O conjunto de dados padrão a ser usado para solicitações. Essa sinalização é ignorada quando não aplicável. É possível definir o valor como project_id:dataset ou dataset. Se project_id estiver ausente, o projeto padrão será usado. Para modificar essa configuração, especifique a sinalização --project_id. O valor padrão é ''.
--debug_mode
Mostra rastreamentos em exceções do Python. O valor padrão é false.
--disable_ssl_validation
Desativa a validação do certificado HTTPS. O valor padrão é false.
--discovery_file
O nome do arquivo JSON a ser lido para descoberta. O valor padrão é ''.
--enable_gdrive
Quando definido como true, um novo token OAuth com escopo do GDrive é solicitado. Quando definido como false, um novo token OAuth sem escopo do GDrive é solicitado.
--fingerprint_job_id
Define se é necessário usar um ID do job derivado de uma impressão digital da configuração do job. Isso impedirá que o mesmo job seja executado várias vezes acidentalmente. O valor padrão é false.
--flagfile
Quando especificada, as definições de sinalização do arquivo fornecido são inseridas na ferramenta de linha de comando bq. O valor padrão é ''.
--format

Especifica o formato da saída do comando. As opções incluem:

  • pretty: saída de tabela formatada
  • sparse: saída de tabela mais simples
  • prettyjson: formato JSON fácil de ler
  • json: JSON compactado ao máximo
  • csv: formato csv com cabeçalho

pretty, sparse e prettyjson foram desenvolvidos para ser legíveis por humanos. json e csv são para transmissão a outro programa. Se none for especificado, o comando não produzirá saída. Se a sinalização --format não estiver presente, um formato de saída apropriado será escolhido com base no comando.

--headless

Especifica se é necessário executar a sessão da bq sem interação do usuário. Quando definido como true, a interação é desativada. Por exemplo, debug_mode não forçará a entrada no depurador, e a frequência da impressão informativa será reduzida. O valor padrão é false.

--job_id

O ID do job exclusivo a ser usado para a solicitação. Se não for especificado em uma solicitação de criação de job, ele será gerado. Essa sinalização aplica-se apenas aos comandos que criam jobs: cp, extract, load e query. Para mais informações, consulte Como executar jobs de maneira programática.

--job_property

Outro par de chave-valor a ser incluído no campo de propriedades da configuração do job. Repita essa sinalização para especificar outras propriedades.

--location

Uma string correspondente ao local da sua região ou multirregião. A sinalização de local é obrigatória nos comandos cancel e show quando você usa a sinalização -j para mostrar informações sobre jobs. Nos comandos a seguir, ela é opcional:

Todos os outros comandos ignoram a sinalização --location.

--max_rows_per_request

Um número inteiro que especifica o número máximo de linhas a serem retornadas por leitura.

--project_id

O ID do projeto a ser usado para solicitações. O valor padrão é ''.

--proxy_address

O nome ou endereço IP do host proxy a ser usado para conexão com o Google Cloud. O valor padrão é ''.

--proxy_password

A senha a ser usada ao autenticar com o host proxy. O valor padrão é ''.

--proxy_port

O número da porta a ser usado para se conectar ao host proxy. O valor padrão é ''.

--proxy_username

O nome de usuário a ser usado na autenticação com o host proxy. O valor padrão é ''.

--quiet ou -q

Se definido como true, ignora as atualizações de status enquanto os jobs estão em execução. O valor padrão é false.

--synchronous_mode ou -sync

Se definido como true, aguarda a conclusão do comando antes de retornar e usa o status de conclusão do job como o código do erro. Se definido como false, o job será criado e o status de conclusão bem-sucedida será usado para o código do erro. O valor padrão é true.

--trace

Um token de rastreamento especificado como token:token para incluir nas solicitações de API.

Sinalizações específicas de comando

É possível usar as sinalizações de comando a seguir na ferramenta de linha de comando bq.

bq add-iam-policy-binding

O comando add-iam-policy-binding recupera a política de gerenciamento de identidade e acesso (IAM, na sigla em inglês) de um recurso (tabela ou visualização) e adiciona uma vinculação à política em uma etapa.

Este comando é uma alternativa ao processo de três etapas do uso do comando get-iam-policy para recuperar o arquivo de política (no formato JSON), editar o arquivo de política e, em seguida, usando o comando set-iam-policy para atualizar a política com uma nova vinculação.

Uso:

bq add-iam-policy-binding --member="MEMBER" --role="ROLE" [-COMMAND_FLAGS] RESOURCE_IDENTIFIER

O comando add-iam-policy-binding usa as seguintes sinalizações e argumentos específicos do comando.

--member
A parte do membro da vinculação de política do IAM. A sinalização --member é obrigatória com a sinalização --role. Uma combinação de --member e --role é igual a uma vinculação. Consulte a política de IAM do IAM para detalhes sobre vinculações.
--role
A parte do papel da vinculação de política do IAM. A sinalização --role é obrigatória, com --member. Uma combinação de sinalizações --member e --role é igual a uma vinculação. Consulte a política de IAM do IAM para detalhes sobre vinculações.
-t --table/view
Quando especificada, adiciona uma vinculação à política do IAM de uma tabela ou visualização. Opcional. O valor padrão é false.

RESOURCE_IDENTIFIER é o recurso (tabela ou visualização) cuja política está sendo atualizada.

bq cancel

O comando cancel é usado para cancelar jobs. O comando cancel não tem sinalizações específicas.

Para mais informações sobre como usar o comando cancel, consulte Como gerenciar jobs.

O comando cancel usa as seguintes sinalizações globais.

--job_id
O ID do job exclusivo a ser usado para a solicitação de cancelamento. É possível especificar o ID do job sem usar a sinalização --job_id, por exemplo: bq cancel [JOB_ID].
--synchronous_mode ou --sync
Quando especificada, aguarda a conclusão do comando antes de retornar. Se configurado como false, o comando retornará imediatamente. O valor padrão é true.

cp do bq

O comando cp é usado para copiar tabelas. O comando cp usa as seguintes sinalizações específicas de comando.

Para mais informações sobre como usar o comando cp, consulte Como gerenciar tabelas.

--append_table ou -a
Quando especificada, copia uma tabela e a anexa a uma tabela atual. O valor padrão é false.
--destination_kms_key
A chave do Cloud KMS usada para criptografia dos dados da tabela de destino.
--force ou -f
Quando especificada, substitui a tabela de destino (se houver) sem enviar prompt. O valor padrão é false.
--no_clobber ou -n
Quando especificada, não substitui a tabela de destino (se houver). O valor padrão é false.

bq extract

O comando extract é usado para exportar dados da tabela ao Cloud Storage.

Para mais informações sobre como usar o comando extract, consulte Como exportar dados da tabela.

O comando extract usa as seguintes sinalizações específicas de comando.

--compression
O tipo de compactação a ser usado para arquivos exportados. Os valores possíveis incluem GZIP (somente CSV e JSON), DEFLATE (somente Avro), SNAPPY (somente Avro) e NONE. O valor padrão é NONE.
--destination_format

O formato dos dados exportados. Os valores possíveis incluem:

  • CSV
  • NEWLINE_DELIMITED_JSON
  • AVRO

O valor padrão é CSV.

--field_delimiter ou -F

O caractere que indica o limite entre as colunas no arquivo de saída para exportações de CSV. \t e tab são permitidos como delimitadores de tabulação.

--print_header

Quando especificada, esse objeto imprime linhas de cabeçalho para formatos que tenham cabeçalhos. O valor padrão é true.

bq get-iam-policy

O comando get-iam-policy recupera a política do IAM para um recurso (tabela ou visualização) e o imprime em stdout. A política está no formato JSON.

Para mais informações sobre o comando get-iam-policy, com exemplos, consulte Introdução aos controles de acesso à tabela.

Uso:

bq get-iam-policy [-COMMAND_FLAG] RESOURCE_IDENTIFIER

O comando get-iam-policy usa a seguinte sinalização específica do comando.

-t --table/view

Quando especificada, recebe a política do IAM de uma tabela ou visualização. Opcional. O valor padrão é false.

RESOURCE_IDENTIFIER é o recurso (tabela ou visualização) cuja política está sendo atualizada.

bq head

O comando head exibe linhas em uma tabela.

Para mais informações sobre como usar o comando head, consulte Como gerenciar dados de tabela.

O comando head usa as seguintes sinalizações específicas de comando.

--job ou -j
Especifique essa sinalização com um ID de job válido para ler os resultados de um job de consulta. O valor padrão é false.
--max_rows ou -n
Um número inteiro que indica a quantidade de linhas a serem impressas ao mostrar dados da tabela. O valor padrão é 100.
--selected_fields ou -c
Uma lista separada por vírgulas que indica um subconjunto de campos (incluindo campos aninhados e repetidos) para retornar ao mostrar dados da tabela. Se não for especificado, todas as colunas serão recuperadas.
--start_row ou -s
Um número inteiro que indica a quantidade de linhas a serem ignoradas antes de mostrar os dados da tabela. O valor padrão é 0 (começa na primeira linha).
--table ou -t
Especifique essa sinalização com um ID de tabela para ler as linhas de uma tabela. O valor padrão é false.

bq insert

O comando insert permite inserir linhas de dados formatados no formato JSON delimitado por nova linha usando o buffer de streaming. Os tipos de dados serão convertidos para corresponder aos tipos de coluna da tabela de destino. Esse comando é usado apenas para testes. Use o método de API insertAll para fazer streaming de dados para o BigQuery.

Para mais informações, consulte Como fazer streaming de dados para o BigQuery.

O comando insert usa as seguintes sinalizações específicas de comando.

--ignore_unknown_values ou -i
Quando especificada, ignora valores em uma linha que não estejam presentes no esquema da tabela.
--skip_invalid_rows ou -s
Quando especificada, tenta inserir qualquer linha válida, mesmo que haja linhas inválidas.
--template_suffix ou -x
Quando especificada, trata a tabela de destino como um modelo base e insere as linhas em uma tabela de instâncias denominada {destination}{templateSuffix}. O BigQuery gerencia a criação da tabela de instâncias usando o esquema do modelo base.

bq load

O comando load carrega dados em uma tabela.

Para mais informações sobre como carregar dados do Cloud Storage usando o comando load, consulte:

Para mais informações sobre como carregar dados de uma origem local usando o comando load, consulte Como carregar dados no BigQuery de uma fonte de dados local.

O comando load usa as seguintes sinalizações específicas de comando.

--allow_jagged_rows
Quando especificada, permite a falta de colunas opcionais à direita nos dados CSV.
--allow_quoted_newlines
Quando especificada, permite novas linhas entre aspas nos dados CSV.
--autodetect
Quando especificada, ativa a detecção automática de esquema para dados CSV e JSON.
--clustering_fields
Uma lista separada por vírgulas de até quatro nomes de colunas.
--destination_kms_key
A chave do Cloud KMS para criptografia dos dados da tabela de destino.
--encoding ou -E
A codificação de caracteres usada nos dados. Os valores possíveis incluem:
  • ISO-8859-1 (também conhecido como Latin-1)
  • UTF-8
--field_delimiter ou -F
O caractere que indica o limite entre colunas nos dados. \t e tab são permitidos como delimitadores de tabulação.
--ignore_unknown_values
Quando especificado, ignora e não carrega linhas de arquivos CSV e JSON com outros valores de colunas que não correspondem ao esquema da tabela. Da mesma forma, para arquivos Avro, Parquet e ORC, campos no esquema de arquivos que não existem no esquema da tabela, serão ignorados e não serão carregados.
--max_bad_records
Um número inteiro que especifica o número máximo de registros inválidos permitidos antes de uma falha em todo o job. O valor padrão é 0. No máximo, cinco erros de qualquer tipo são retornados, seja qual for o valor de --max_bad_records.
--null_marker
Uma string personalizada opcional que representa um valor NULL nos dados CSV.
--projection_fields
Se usado com --source_format definido como DATASTORE_BACKUP, indica quais propriedades da entidade serão carregadas de uma exportação do Cloud Datastore como uma lista separada por vírgulas. Nomes de propriedades diferenciam maiúsculas e minúsculas e precisam fazer referência às propriedades de nível superior. O valor padrão é ''. Essa sinalização também pode ser usada com exportações do Firestore.
--quote
O caractere de aspas a ser usado antes e depois dos registros. O valor padrão é ". Para não indicar nenhum caractere de aspas, use uma string vazia.
--replace
Quando especificada, todos os dados e esquemas atuais são apagados quando novos dados são carregados. Todas as chaves do Cloud KMS também são removidas, a menos que você especifique a sinalização --destination_kms_key. O valor padrão é false.
--schema
O caminho para um arquivo de esquema JSON local ou uma lista separada por vírgulas de definições de coluna no formato field:data_type, field:data_type.
--schema_update_option

Ao anexar dados a uma tabela (em um job de carregamento ou consulta) ou ao substituir uma partição de tabela, especifica como atualizar o esquema da tabela de destino. Os valores possíveis incluem:

  • ALLOW_FIELD_ADDITION: permite que novos campos sejam adicionados.
  • ALLOW_FIELD_RELAXATION: permite o relaxamento de campos REQUIRED para NULLABLE.

Repita essa sinalização para especificar várias opções de atualização de esquema.

--skip_leading_rows

Um número inteiro que especifica a quantidade de linhas a ser ignorada no início do arquivo de origem.

--source_format

O formato dos dados de origem. Os valores possíveis incluem:

  • CSV
  • NEWLINE_DELIMITED_JSON
  • AVRO
  • DATASTORE_BACKUP
  • PARQUET
  • ORC
--time_partitioning_expiration

Um número inteiro que especifica (em segundos) quando uma partição baseada em tempo precisa ser excluída. O prazo de validade é a soma da data UTC da partição com o valor do número inteiro. Um número negativo indica que não há validade.

--time_partitioning_field

O campo usado para determinar como criar uma partição baseada em tempo. Se o particionamento baseado em tempo estiver ativado sem esse valor, a tabela será particionada com base no tempo de carregamento.

--time_partitioning_type

Ativa o particionamento baseado em tempo na tabela e define o tipo de partição. Os valores possíveis incluem DAY, HOUR, MONTHou YEAR.

--use_avro_logical_types

Se sourceFormat for definido como AVRO, indicará se é necessário converter os tipos lógicos nos tipos correspondentes (como TIMESTAMP), em vez de apenas usar os tipos brutos (como INTEGER).

bq ls

O comando ls lista objetos em uma coleção.

Para mais informações sobre como usar o comando ls, consulte:

O comando ls usa as seguintes sinalizações específicas de comando.

--all ou -a
Quando especificada, mostra todos os resultados: jobs de todos os usuários ou todos os conjuntos de dados (incluindo os ocultos). Essa sinalização não é necessária ao listar configurações ou execuções de transferência.
--capacity_commitment
Quando especificada, lista compromissos de capacidade. O valor padrão é false.
--datasets ou -d
Quando especificada, lista os conjuntos de dados. O valor padrão é false.
--filter
Lista os conjuntos de dados que correspondem à expressão do filtro. Use uma lista separada por espaço de chaves e valores de rótulo no formato labels.key:value. Para configurações de transferência, uma expressão de filtro no formato dataSourceIds:data_sources lista configurações de transferência para fontes de dados especificadas. Os valores possíveis incluem:
  • dcm_dt: Campaign Manager
  • dcm_dt: Campaign Manager
  • google_cloud_storage: Cloud Storage
  • dfp_dt: Google Ad Manager
  • adwords: Google Ads
  • merchant_center: Google Merchant Center
  • play: Google Play
  • doubleclick_search: Search Ads 360
  • youtube_channel: relatórios de canal do YouTube
  • youtube_content_owner: relatórios do proprietário do conteúdo do YouTube

Também usada para execuções de transferência, uma expressão de filtro no formato states:state lista as execuções de transferência com os estados especificados. Os valores possíveis incluem:

  • SUCCEEDED
  • FAILED
  • PENDING
  • RUNNING
  • CANCELLED
--jobs ou -j
Quando especificada, lista os jobs. O valor padrão é false. Por padrão, o limite é de 100.000 resultados.
--max_creation_time
Um número inteiro que representa um carimbo de data/hora em milissegundos. Quando especificada com -j, essa sinalização lista os jobs criados antes do carimbo de data/hora.
--max_results ou -n
Um número inteiro indicando a quantidade máxima de resultados. O valor padrão é 50
.
--min_creation_time
Um número inteiro que representa um carimbo de data/hora em milissegundos. Quando especificada com -j, essa sinalização lista os jobs criados depois do carimbo de data/hora.
--message_type

Para listar mensagens de registro de execução de transferência de um tipo específico, use messageTypes:message_type. Os valores possíveis incluem:

  • INFO
  • WARNING
  • ERROR
--models ou -m

Quando especificada, lista os modelos de ML do BigQuery.

--page_token ou -k

Quando especificada, lista os itens a partir desse token da página.

--projects ou -p

Quando especificada, mostra todos os projetos. O valor padrão é false.

--reservation

Quando especificada, lista todas as reservas de um determinado projeto e local. O valor padrão é false.

--reservation_assignment

Quando especificada, lista todas as atribuições de reserva para um determinado projeto e local. O valor padrão é false.

--run_attempt

Defina essa sinalização como LATEST para listar apenas as últimas execuções de uma transferência.

--transfer_config

Quando especificada, lista as configurações de transferência. Ao usar essa sinalização, você também precisa especificar --transfer_location. O valor padrão é false.

--transfer_location

Lista as configurações de transferência no local especificado. O local da transferência é definido quando ela é criada.

--transfer_log

Quando especificada, lista as mensagens do registro de transferência para a execução especificada. O valor padrão é false.

--transfer_run

Quando especificada, lista as execuções de transferência. O valor padrão é false.

bq mk

O comando mk cria vários recursos do BigQuery, incluindo conjuntos de dados, tabelas, visualizações, visualizações materializadas e configurações de transferência.

O comando mk usa uma sinalização de tipo que especifica o tipo de recurso a ser criado e outras sinalizações que dependem do tipo de recurso.

bq mk TYPE_FLAG [ OTHER FLAGS ] [ ARGS ]

em que TYPE_FLAG é uma das opções abaixo:

Além das sinalizações específicas de comando listadas abaixo, o bq mk é compatível com a sinalização a seguir:

--force ou -f
Ignora erros se um recurso com o mesmo nome já existir. Quando especificada, se um recurso já existir, o código de saída será 0. Essa sinalização não faz com que o comando mk substitua o recurso. O valor padrão é false.

bq mk --capacity_commitment

Adquire um compromisso de capacidade. Para mais informações, consulte Como trabalhar com compromissos. As sinalizações a seguir são compatíveis:

--location
O local do projeto.
--plan
O tipo de plano. Uma das seguintes opções: FLEX, MONTHLY, ANNUAL.
--project_id
O ID do projeto que administrará os slots.
--slots
O número de slots para compra.

bq mk --dataset

Cria um conjunto de dados. Para mais informações, consulte Como criar conjuntos de dados. As sinalizações a seguir são compatíveis:

--data_location
(Legado) Especifica o local do conjunto de dados. Em vez disso, use a sinalização global --location.
--default_kms_key
A chave do Cloud KMS usada para criptografar os dados da tabela em um conjunto de dados, caso nenhuma chave explícita seja fornecida durante a criação ou consulta da tabela.
--default_partition_expiration
Um número inteiro que especifica o prazo de validade padrão, em segundos, para todas as partições em tabelas particionadas recém-criadas em um conjunto de dados. O prazo de validade é definido como a data UTC da partição acrescida do valor de número inteiro. Se essa propriedade for definida, ela substituirá a validade da tabela padrão no nível do conjunto de dados, se houver. Se você fornecer a sinalização --time_partitioning_expiration ao criar ou atualizar uma tabela particionada, a validade da partição no nível da tabela terá prioridade sobre a validade da partição padrão no nível do conjunto de dados.
--default_table_expiration
Um número inteiro que especifica o ciclo de vida padrão, em segundos, para tabelas recém-criadas em um conjunto de dados. O prazo de validade é definido como a hora UTC atual mais esse valor.
--description
A descrição do conjunto de dados.
--label
Um rótulo para o conjunto de dados. O formato é key:value. Repita essa sinalização para especificar vários rótulos.

bq mk --materialized_view

Cria uma visualização materializada. As sinalizações a seguir são compatíveis:

--enable_refresh
Se a atualização automática está ativada para uma visualização materializada. O padrão ao criar uma visualização materializada é true.
--refresh_interval_ms
O tempo, em milissegundos, para o intervalo de atualização de uma visualização materializada. Se não for especificado, o intervalo de atualização de uma visualização materializada com atualização ativada será de 1.800.000 milissegundos, ou seja, 30 minutos.

Para mais informações, consulte Como criar e usar visualizações materializadas.

bq mk --reservation

Cria uma reserva com slots dedicados. Para mais informações, consulte Como trabalhar com reservas. As sinalizações a seguir são compatíveis:

--ignore_idle_slots
Se for true, os jobs em execução nesta reserva usarão apenas os slots alocados para a reserva. Se for false, os jobs dessa reserva poderão usar slots inativos de outras reservas ou aqueles que não estão alocados para nenhuma reserva. O valor padrão é false. Para mais informações, consulte Slots inativos.
--location
O local do projeto.
--project_id
O ID do projeto que é proprietário da reserva.
--slots
O número de slots a serem alocados para esta reserva.

bq mk --reservation_assignment

Atribui um projeto, uma pasta ou uma organização a uma reserva. Para saber mais, consulte Como trabalhar com atribuições. As sinalizações a seguir são compatíveis:

--assignee_id
O ID da pasta, organização ou projeto.
--assignee_type
O tipo de entidade a ser atribuído à reserva. Um de FOLDER, ORGANIZATION ou PROJECT.
--job_type
O tipo de job a ser atribuído à reserva. Um de: QUERY, PIPELINE ou ML_EXTERNAL.
--location
O local do projeto.
--project_id
O ID do projeto que é proprietário da reserva.
reservation_id
O ID da reserva.

bq mk --table

Cria uma tabela. Para mais informações, consulte Como criar e usar tabelas. As sinalizações a seguir são compatíveis:

--clustering_fields
Uma lista separada por vírgulas com nomes de colunas usada para armazenar uma tabela em cluster. Quando especificada, a tabela é agrupada usando as colunas fornecidas. Se especificada com particionamento, a tabela será particionada e, em seguida, cada partição será agrupada usando as colunas fornecidas.
--description
A descrição da tabela.
--destination_kms_key
A chave do Cloud KMS usada para criptografar os dados da tabela.
--expiration
Um número inteiro que especifica o prazo de validade da tabela. O prazo de validade é definido como a hora UTC atual mais esse valor.
--external_table_definition
Especifica uma definição de tabela usada para criar uma tabela externa. O valor pode ser uma definição de tabela in-line ou um caminho para um arquivo que contém uma definição de tabela JSON. O formato de uma definição in-line é schema@format=uri.
--label
Um rótulo para colocar na tabela. O formato é key:value. Repita essa sinalização para especificar vários rótulos.
--range_partitioning

Especifica opções para uma partição de intervalo de números inteiros, como uma lista separada por vírgulas do formato column_name,start,end,interval, em que

  • column_name é a coluna usada para criar as partições por intervalo de números inteiros;
  • start é o início do particionamento por intervalo, inclusivo;
  • end é o fim do particionamento por intervalo, exclusivo;
  • interval é a largura de cada intervalo dentro da partição.
--require_partition_filter

Quando especificada, essa sinalização determina se um filtro de partição é necessário para consultas na tabela fornecida. Essa sinalização só se aplica a tabelas particionadas. O valor padrão é false.

--schema

O caminho para um arquivo de esquema JSON local ou uma lista separada por vírgulas de definições de coluna no formato field:data_type,field:data_type. O valor padrão é ''.

--time_partitioning_expiration

Um número inteiro que especifica (em segundos) quando uma partição baseada em tempo precisa ser excluída. O prazo de validade é a soma da data UTC da partição com o valor do número inteiro. Um número negativo indica que não há validade.

--time_partitioning_field

O campo usado para determinar como criar uma partição baseada em tempo. Se o particionamento baseado em tempo estiver ativado sem esse valor, a tabela será particionada com base no tempo de carregamento.

--time_partitioning_type

Ativa o particionamento baseado em tempo na tabela e define o tipo de partição. Os valores possíveis incluem DAY, HOUR, MONTHou YEAR.

bq mk --transfer_config

Cria uma configuração de transferência. As sinalizações a seguir são compatíveis:

--data_source
Especifica a fonte de dados. Obrigatório ao criar uma configuração de transferência. Os valores possíveis incluem:
  • dcm_dt: Campaign Manager
  • dcm_dt: Campaign Manager
  • google_cloud_storage: Cloud Storage
  • dfp_dt: Google Ad Manager
  • adwords: Google Ads
  • merchant_center: Google Merchant Center
  • play: Google Play
  • doubleclick_search: Search Ads 360
  • youtube_channel: relatórios de canal do YouTube
  • youtube_content_owner: relatórios do proprietário do conteúdo do YouTube

O valor padrão é ''.

--display_name
O nome de exibição da configuração de transferência. O valor padrão é ''.
--params ou -p
Os parâmetros da configuração de transferência no formato JSON: {"parameter":"value"}. Os parâmetros variam de acordo com a fonte de dados. Para mais informações, consulte Introdução ao serviço de transferência de dados do BigQuery.
--refresh_window_days
Um número inteiro que especifica a janela de atualização para uma configuração de transferência em dias. O valor padrão é 0.
--target_dataset
O conjunto de dados de destino na configuração da transferência. O valor padrão é ''.

Para informações sobre como usar o comando mk com o serviço de transferência de dados do BigQuery, consulte:

bq mk --transfer_run

Cria uma execução de transferência. As sinalizações a seguir são compatíveis:

--start_time
Um carimbo de data/hora que especifica o horário de início para um intervalo de execuções de transferência. O formato é RFC3339 UTC "Zulu".
--end_time
Um carimbo de data/hora que especifica o horário de término para um intervalo de execuções de transferência. O formato é RFC3339 UTC "Zulu".

bq mk --view

Cria uma visualização. Para mais informações, consulte Como criar visualizações. As sinalizações a seguir são compatíveis:

--description
A descrição da visualização.
--expiration
Um número inteiro que especifica o prazo de validade da visualização. O prazo de validade é definido como a hora UTC atual mais esse valor.
--label
Um rótulo para colocar na visualização. O formato é key:value. Repita essa sinalização para especificar vários rótulos.
--use_legacy_sql
Quando definida como false, usa uma consulta SQL padrão para criar uma visualização. O valor padrão é true (usa SQL legado).
--view_udf_resource
O URI do Cloud Storage ou o caminho para um arquivo de código local que é carregado e avaliado imediatamente como um recurso de função definido pelo usuário usado pela consulta SQL de uma visualização. Repita essa sinalização para especificar vários arquivos.

bq mkdef

O comando mkdef cria uma definição de tabela no formato JSON para dados armazenados no Cloud Storage ou no Drive.

Para mais informações sobre como usar o comando mkdef, consulte Como criar um arquivo de definição de tabela para uma fonte de dados externa.

O comando mkdef usa as seguintes sinalizações específicas de comando.

--autodetect
Quando especificada, usa a detecção automática de esquema para dados CSV e JSON.
--ignore_unknown_values ou -i
Quando especificada, ignora valores em uma linha que não estejam presentes no esquema.
--source_format
O formato dos dados de origem. Os valores possíveis incluem:
  • CSV
  • NEWLINE_DELIMITED_JSON
  • AVRO
  • DATASTORE_BACKUP
  • GOOGLE_SHEETS O valor padrão é CSV.

bq partition

O comando partition é usado para converter tabelas com datas como nome (terminando em YYYYMMDD) em tabelas particionadas.

Para mais informações sobre como usar o comando partition, consulte Como converter tabelas fragmentadas por data em tabelas particionadas por tempo de ingestão.

O comando partition usa as seguintes sinalizações específicas de comando.

--no_clobber ou -n
Quando especificada, não substitui uma partição atual. O valor padrão é false.
--time_partitioning_expiration
Um número inteiro que especifica (em segundos) quando uma partição baseada em tempo precisa ser excluída. O prazo de validade é a soma da data UTC da partição com o valor do número inteiro. Um número negativo indica que não há validade.
--time_partitioning_type
Especifica o tipo de partição. Os valores possíveis incluem DAY, HOUR, MONTHou YEAR.

bq query

O comando query cria um job de consulta que executa a consulta SQL fornecida.

Para mais informações sobre como usar o comando query, consulte Como executar consultas interativas e em lote.

O comando query usa as seguintes sinalizações específicas de comando.

--allow_large_results
Quando especificada, ativa tamanhos de tabela de destino grandes para consultas SQL legadas.
--append_table
Quando especificada, anexa dados a uma tabela de destino. O valor padrão é false.
--batch
Quando especificada, executa a consulta no modo em lote. O valor padrão é false.
--clustering_fields
Se especificada, uma lista separada por vírgulas de colunas é usada para agrupar a tabela de destino em uma consulta. Quando especificada, a tabela é agrupada usando as colunas fornecidas. Se especificada com particionamento, a tabela será particionada e, em seguida, cada partição será agrupada usando as colunas fornecidas.
--destination_kms_key
A chave do Cloud KMS usada para criptografar os dados da tabela de destino.
--destination_schema
O caminho para um arquivo de esquema JSON local ou uma lista separadas por vírgulas de definições de coluna no formato field:data_type,field:data_type. O valor padrão é ''.
--destination_table
O nome da tabela de destino para gravar os resultados da consulta. O valor padrão é ''.
--dry_run
Quando especificada, a consulta é validada, mas não executada.
--external_table_definition
A definição do nome da tabela e de esquema usada em uma consulta de tabela externa. O esquema pode ser o caminho para um arquivo de esquema JSON local ou uma lista separada por vírgulas de definições de coluna no formato field:data_type,field:data_type. O formato para fornecer o nome e o esquema da tabela é: table::path_to_file ou table::schema@source_format=cloud_storage_uri. Repita essa sinalização para consultar várias tabelas.
--flatten_results
Quando especificada, padroniza campos aninhados e repetidos nos resultados de consultas SQL legadas. O valor padrão é true.
--label
Um rótulo para aplicar a um job de consulta no formulário key:value. Repita essa sinalização para especificar vários rótulos.
--max_rows ou -n
Um número inteiro que especifica o número de linhas a retornar nos resultados da consulta. O valor padrão é 100.
--maximum_bytes_billed
Um número inteiro que limita os bytes faturados pela consulta. Se a consulta ultrapassar o limite, ela falhará (sem gerar cobranças). Se não especificado, os bytes faturados são definidos como o padrão do projeto.
--min_completion_ratio
[Experimental] Um número entre 0 e 1 que especifica a fração mínima de dados que precisam ser verificados antes que uma consulta seja retornada. Se não for definido, será usado o valor padrão 1.0 do servidor.
--parameter
Um arquivo JSON contendo uma lista de parâmetros de consulta ou um parâmetro de consulta no formulário name:type:value. Um nome vazio gera um parâmetro de posição. type pode ser omitido para assumir um valor STRING no formato name::value ou ::value. NULL produz um valor nulo. Repita essa sinalização para especificar vários parâmetros.
--replace
Se especificada, substitui a tabela de destino pelos resultados da consulta. O valor padrão é false.
--require_cache
Se especificada, executa a consulta apenas se os resultados puderem ser recuperados do cache.
--require_partition_filter
Se especificada, requer um filtro de partição para consultas na tabela fornecida. Essa sinalização só pode ser usada com uma tabela particionada.
--rpc
Se especificada, usa a API de consulta no estilo rpc em vez do método jobs.insert da API REST. O valor padrão é false.
--schedule
Transforma uma consulta em uma consulta programada recorrente. É necessário definir uma frequência de execução da consulta. Exemplos:
  • --schedule='every 24 hours'
  • --schedule='every 3 hours'
--schema_update_option

Ao anexar dados a uma tabela (em um job de carregamento ou consulta) ou ao substituir uma partição de tabela, especifica como atualizar o esquema da tabela de destino. Os valores possíveis incluem:

  • ALLOW_FIELD_ADDITION: permite que novos campos sejam adicionados.
  • ALLOW_FIELD_RELAXATION: permite o relaxamento de campos REQUIRED para NULLABLE.

Repita essa sinalização para especificar várias opções de atualização de esquema.

--start_row ou -s

Um número inteiro que especifica a primeira linha a retornar no resultado da consulta. O valor padrão é 0.

--target_dataset

Quando especificada com --schedule, atualiza o conjunto de dados de destino para uma consulta programada. A consulta deve ser DDL ou DML.

--time_partitioning_expiration

Um número inteiro que especifica (em segundos) quando uma partição baseada em tempo precisa ser excluída. O prazo de validade é a soma da data UTC da partição com o valor do número inteiro. Um número negativo indica que não há validade.

--time_partitioning_field

O campo usado para determinar como criar uma partição baseada em tempo. Se o particionamento baseado em tempo estiver ativado sem esse valor, a tabela será particionada com base no tempo de carregamento.

--time_partitioning_type

Quando usado com a sinalização destination_table, especifica o tipo de partição da tabela de destino. Os valores possíveis incluem DAY, HOUR, MONTHou YEAR.

--udf_resource

Essa sinalização aplica-se somente a consultas SQL legadas. Quando especificada, este é o URI do Cloud Storage ou o caminho para um arquivo de código local que é carregado e avaliado imediatamente como um recurso de função definido pelo usuário usado por uma consulta de SQL legado. Repita essa sinalização para especificar vários arquivos.

--use_cache

Quando especificada, armazena em cache os resultados da consulta. O valor padrão é true.

--use_legacy_sql

Quando definida como false, executa uma consulta SQL padrão. O valor padrão é true (usa SQL legado).

bq remove-iam-policy-binding

O comando remove-iam-policy-binding recupera a política do IAM para um recurso (tabela ou visualização) e remove uma vinculação da política, em uma etapa.

Este comando é uma alternativa ao processo de três etapas do uso do comando get-iam-policy para recuperar o arquivo de política (no formato JSON), editar o arquivo de política e, em seguida, usando o comando set-iam-policy para atualizar a política sem a vinculação.

Uso:

bq remove-iam-policy-binding --member="MEMBER" --role="ROLE" [-COMMAND_FLAGS] RESOURCE_IDENTIFIER

O comando remove-iam-policy-binding usa as seguintes sinalizações e argumentos específicos do comando.

--member
A parte do membro da vinculação de política do IAM. A sinalização --member é obrigatória com a sinalização --role. Uma combinação de --member e --role é igual a uma vinculação. Consulte a política de IAM do IAM para detalhes sobre vinculações.
--role
A parte do papel da vinculação de política do IAM. A sinalização --role é obrigatória, com --member. Uma combinação de sinalizações --member e --role é igual a uma vinculação. Consulte a política de IAM do IAM para detalhes sobre vinculações.
-t --table/view
Quando especificada, remove uma vinculação da política do IAM de uma tabela ou visualização. Opcional. O valor padrão é false.

RESOURCE_IDENTIFIER é o recurso (tabela ou visualização) cuja política está sendo atualizada.

bq rm

O comando rm exclui um compromisso de capacidade, um conjunto de dados, um modelo, uma reserva, uma atribuição de reserva, uma tabela, uma configuração de transferência ou uma visualização.

Para mais informações sobre como usar o comando rm, consulte:

O comando rm usa as seguintes sinalizações específicas de comando.

--capacity_commitment
Quando especificada, exclui um compromisso de capacidade. O valor padrão é false.
--dataset ou -d
Quando especificada, exclui um conjunto de dados. O valor padrão é false.
--force ou -f
Quando especificada, exclui uma tabela, visualização, modelo ou conjunto de dados sem prompt. O valor padrão é false.
--model ou -m
Quando especificada, exclui um modelo de ML do BigQuery.
--recursive ou -r
Quando especificada, exclui um conjunto de dados e quaisquer tabelas, dados da tabela ou modelos contidos nele. O valor padrão é false.
--reservation
Quando especificada, exclui uma reserva. O valor padrão é false.
--reservation_assignment
Quando especificada, exclui uma atribuição de reserva. O valor padrão é false.
--table ou -t
Quando especificada, exclui uma tabela. O valor padrão é false.
--transfer_config
Quando especificada, exclui uma configuração de transferência. O valor padrão é false.

bq set-iam-policy

O comando set-iam-policy define (ou atualiza) a política do IAM para um recurso (tabela ou visualização). Depois de definir a política, a nova política é impressa em stdout. A política está no formato JSON.

O campo etag na política atualizada precisa corresponder ao valor etag da política atual. Caso contrário, a atualização falhará. Esse recurso evita atualizações simultâneas.

Você pode conseguir a política atual e o valor etag com o comando bq get-iam-policy.

Para mais informações sobre o comando set-iam-policy, com exemplos, consulte Introdução aos controles de acesso à tabela.

Uso:

bq get-iam-policy [-COMMAND_FLAG] RESOURCE_IDENTIFIER FILE_NAME

O comando set-iam-policy usa as seguintes sinalizações e argumentos específicos de comando.

-t --table/view
Quando especificada, define a política do IAM de uma tabela ou visualização. Opcional. O valor padrão é false.

RESOURCE_IDENTIFIER é o recurso (tabela ou visualização) cuja política está sendo atualizada.

FILE_NAME é o nome de um arquivo que contém a política no formato JSON.

bq show

O comando show exibe informações sobre um objeto.

Para mais informações sobre como usar o comando show, consulte:

O comando show usa as seguintes sinalizações específicas de comando.

--assignee_id
Quando usado com a sinalização reservation_assignment, especifica o ID de uma pasta, organização ou projeto. Use a sinalização --assignee_type para especificar o tipo de cessionário a ser exibido.
--assignee_type
Quando usado com a sinalização reservation_assignment, especifica o tipo de cessionário a ser exibido. Um de FOLDER, ORGANIZATION ou PROJECT.
--reservation
Se especificado, mostra informações sobre uma reserva. O valor padrão é false.
--dataset ou -d
Quando especificada, exibe informações sobre um conjunto de dados. O valor padrão é false.
--encryption_service_account
Quando especificada, exibe a conta de serviço para um usuário, se existir, ou cria uma, se necessário. O valor padrão é false.
--job ou -j
Se especificada, mostra informações sobre um job. O valor padrão é false.
--job_type
Quando usado com a sinalização reservation_assignment, especifica o tipo de atribuição de reserva de job a ser exibido. Um de QUERY, PIPELINE ou ML_EXTERNAL.
--model ou -m
Se especificada, mostra informações sobre um modelo de ML do BigQuery.
--reservation
Se especificado, mostra informações sobre uma reserva. O valor padrão é false.
--reservation_assignment
Se especificado, mostra informações sobre atribuições de reserva para uma pasta, organização ou projeto especificado. Se o recurso de destino tiver atribuições explícitas, elas serão mostradas. Caso contrário, o comando mostrará todas as atribuições herdadas dos recursos pai. Por exemplo, um projeto pode herdar atribuições da pasta pai. Ao usar essa sinalização, as sinalizações --job_type, --assignee_type e --assignee_id são aplicáveis.
--schema
Quando especificada, exibe apenas o esquema da tabela. O valor padrão é false.
--transfer_config
Quando especificada, exibe informações sobre uma configuração de transferência. O valor padrão é false.
--transfer_run
Quando especificada, exibe informações sobre uma execução de transferência. O valor padrão é false.
--view
Quando especificada, exibe informações sobre uma visualização. O valor padrão é false.

bq update

O comando update atualiza um compromisso de capacidade, um conjunto de dados, um modelo, uma reserva, uma atribuição de reserva, uma tabela, uma configuração de transferência ou uma visualização.

Para mais informações sobre como usar o comando update, consulte:

O comando update usa as seguintes sinalizações específicas de comando.

--capacity_commitment
Se especificada, atualiza um compromisso de capacidade. O valor padrão é false. Use essa sinalização com as sinalizações --merge, --plan, --renewal_plan, --split e --slots.
--clear_label
Remove um rótulo usando o formato key:. Repita essa sinalização para remover vários rótulos.
--dataset ou -d
Atualiza um conjunto de dados. O valor padrão é false.
--default_kms_key
Atualiza um conjunto de dados, define a chave do Cloud KMS usada para criptografar os dados da tabela em um conjunto de dados caso nenhuma chave explícita seja fornecida durante a criação ou consulta da tabela.
--default_partition_expiration

Um número inteiro que especifica o prazo de validade padrão, em segundos, para todas as partições em tabelas particionadas recém-criadas em um conjunto de dados. Essa sinalização não tem valor mínimo.

O prazo de validade é definido como a data UTC da partição acrescida do valor de número inteiro. Se essa propriedade for definida, ela substituirá a validade da tabela padrão no nível do conjunto de dados, se houver. Se você fornecer a sinalização --time_partitioning_expiration ao criar ou atualizar uma tabela particionada, a validade da partição no nível da tabela terá prioridade sobre a validade da partição padrão no nível do conjunto de dados. Especifique 0 para remover uma validade atual.

--default_table_expiration

Um número inteiro que atualiza a duração padrão, em segundos, para tabelas recém-criadas em um conjunto de dados. O prazo de validade é definido como a hora UTC atual mais esse valor. Especifique 0 para remover a validade atual.

--description

Atualiza a descrição de um conjunto de dados, tabela, modelo ou visualização.

--destination_reservation_id

Quando usado com a sinalização --reservation_assignment, move uma atribuição de reserva atual para a reserva especificada. O valor é o ID da reserva de destino. Para mais informações, consulte Mover uma atribuição para uma reserva diferente.

--display_name

Atualiza o nome de exibição para uma configuração de transferência. O valor padrão é ''.

--etag

Atualiza os recursos somente se houver correspondência do etag.

--expiration

Um número inteiro que atualiza o prazo de validade em segundos para uma tabela, visualização ou modelo. Especifique 0 para remover o prazo de validade.

--external_table_definition

Atualiza uma tabela externa com a definição de tabela especificada. O esquema pode ser um caminho para um arquivo de esquema JSON local ou uma lista separada por vírgulas de definições de coluna no formato field:data_type,field:data_type. O formato para fornecer o nome e o esquema da tabela é: table::path_to_file ou table::schema@source_format=cloud_storage_uri.

--ignore_idle_slots

Usado com a sinalização --reservation. Se for true, os jobs em execução na reserva especificada usarão somente os slots alocados para aquela reserva. Se for false, os jobs dessa reserva poderão usar slots inativos de outras reservas ou aqueles que não estão alocados para nenhuma reserva. O valor padrão é false. Para mais informações, consulte Slots inativos.

--merge

Quando usado com a sinalização --capacity_commitment, combina dois compromissos de capacidade. O valor padrão é false. Para mais informações, consulte Mesclar dois compromissos.

--model ou -m

Atualiza os metadados de um modelo de ML do BigQuery.

--params ou -p

Atualiza parâmetros para uma configuração de transferência no formato JSON: {"parameter":"value"}. Os parâmetros variam de acordo com a fonte de dados. Para mais informações, consulte Introdução ao serviço de transferência de dados do BigQuery.

--plan

Quando usado com a sinalização --capacity_commitment, converte um compromisso de capacidade em um plano de compromisso de maior duração. Uma das seguintes opções: FLEX, MONTHLY, ANNUAL. O valor padrão é ''.

--refresh_window_days

Um número inteiro que especifica uma janela atualizada (em dias) para uma configuração de transferência.

--renewal_plan

Quando usado com a sinalização --capacity_commitment, especifica o plano de renovação de um compromisso de capacidade atual. Uma das seguintes opções: FLEX, MONTHLY, ANNUAL. O valor padrão é ''.

--reservation

Se especificado, atualiza uma reserva. O valor padrão é false.

--reservation_assignment

Se especificado, atualiza uma atribuição de reserva. O valor padrão é false.

--schema

O caminho para um arquivo de esquema JSON local ou uma lista separada por vírgulas de definições de coluna no formato field:data_type,field:data_type. O valor padrão é ''.

--set_label

Um rótulo a ser atualizado no formulário key:value. Repita essa sinalização para atualizar vários rótulos.

--slots

Quando usado com as sinalizações --capacity_commitment e --split, especifica o número de slots a serem divididos de um compromisso de capacidade atual em um novo compromisso. Quando usado com a sinalização --reservation, atualiza o número de slots em uma reserva.

--source

O caminho para o arquivo JSON local que contém um payload usado para atualizar um recurso. Por exemplo, é possível usar essa sinalização para especificar um arquivo JSON que contenha um recurso de conjunto de dados com uma propriedade de access atualizada. O arquivo é usado para substituir os controles de acesso do conjunto de dados.

--split

Quando usado com a sinalização --capacity_commitment, divide um compromisso de capacidade atual. O valor padrão é false. Para mais informações, consulte Dividir um compromisso.

--table ou -t

Quando especificada, atualiza uma tabela. O valor padrão é false.

--target_dataset

Quando especificada, atualiza o conjunto de dados de destino para uma configuração de transferência. O valor padrão é ''.

--time_partitioning_expiration

Um número inteiro que atualiza (em segundos) quando uma partição baseada em tempo precisa ser excluída. O prazo de validade é a soma da data UTC da partição com o valor do número inteiro. Um número negativo indica que não há validade.

--time_partitioning_field

Atualiza o campo usado para determinar como criar uma partição baseada em tempo. Se o particionamento baseado em tempo estiver ativado sem esse valor, a tabela será particionada com base no tempo de carregamento.

--time_partitioning_type

Especifica o tipo de particionamento. Os valores possíveis incluem DAY, HOUR, MONTHou YEAR. Não é possível alterar o tipo de particionamento de uma tabela existente.

--transfer_config

Quando especificada, atualiza uma configuração de transferência. O valor padrão é false.

--update_credentials

Quando especificada, atualiza as credenciais de configuração de transferência. O valor padrão é false.

--use_legacy_sql

Quando definida como false, atualiza a consulta de SQL legado de uma exibição para SQL padrão. O valor padrão é true, que usa SQL legado.

--view

Quando especificada, atualiza a consulta SQL de uma exibição. O valor padrão é ''.

--view_udf_resource

Atualiza o URI do Cloud Storage ou o caminho para um arquivo de código local, carregado e avaliado imediatamente, como recurso de uma função definida pelo usuário na consulta SQL de uma visualização. Repita essa sinalização para especificar vários arquivos.

bq wait

O comando wait aguarda alguns segundos para que um job seja concluído.

O comando wait usa a sinalização global --job_id e as seguintes sinalizações específicas do comando.

integer
Um valor inteiro maior ou igual a 0 que especifica o tempo de espera. Esse valor não é uma sinalização: você especifica o número inteiro na linha de comando. Se você digitar 0, o comando pesquisará a conclusão do job e retornará imediatamente. Se você não especificar um valor inteiro, o comando aguardará para sempre.
--fail_on_error
Quando especificada, após o tempo de espera decorrido, ocorrerá um erro se o job ainda estiver em execução ou terminar em falha. O valor padrão é true.
--wait_for_status

Quando especificada, aguarda um determinado status do job antes de sair. Os valores possíveis incluem:

  • PENDING
  • RUNNING
  • DONE

O valor padrão é DONE.