export comando

Exporte ou gere um arquivo de esquema GraphQL e salve-o no disco. Dois modos são suportados:

• Buscar esquema existente de uma instância de tempo de execução temporária do DAB
• Gerar esquema a partir do Cosmos DB para dados NoSQL usando amostragem

Sintaxe

dab export --graphql -o <output-directory> [options]

Visão rápida

* --graphql Não é obrigatório para parser, mas a exportação falha a menos que a forneças.

Comportamento

No modo de exportação (sem --generate), o DAB tenta https://localhost:5001 primeiro e volta a http://localhost:5000.

O modo de exportação tenta a recuperação do esquema até cinco vezes. O modo de geração usa uma única tentativa.

Esquema vazio resulta em erro: "O esquema GraphQL gerado está vazio. Garantir que os dados estão disponíveis para gerar o esquema."

Modos de amostragem

TopNExtractor

• Exemplos N documentos recentes
• Filtro de tempo opcional com --sampling-days

Utilização para conjuntos de dados mais pequenos e uniformes

EligibleDataSampler

• Amostragem com reconhecimento de partição
• N documentos por partição
• --sampling-partition-key-path opcional

Utilização para partições com esquemas variados

TimePartitionedSampler

• Divide min/max _ts em grupos de tempo
• N documentos por grupo
• --sampling-group-count opcional (por defeito 10)

Use quando o esquema evolui ao longo do tempo

--graphql

Permite a exportação de esquema. Sem isso, exportar regista um erro e não produz um ficheiro de esquema.

Example

dab export \
  --graphql \
  -o ./schema-out

dab export ^
  --graphql ^
  -o .\schema-out

-o, --output

Diretório para arquivo de esquema. Criado se faltar.

Example

dab export \
  --graphql \
  -o ./schema-out

dab export ^
  --graphql ^
  -o .\schema-out

-g, --graphql-schema-file

Somente nome de arquivo de saída, o padrão é schema.gql.

Example

dab export \
  --graphql \
  -o ./out \
  -g custom-schema.gql

dab export ^
  --graphql ^
  -o .\out ^
  -g custom-schema.gql

--generate

• false (padrão): Iniciar tempo de execução, esquema introspect
• true: Gerar esquema a partir do Azure Cosmos DB para dados NoSQL

Example

dab export \
  --graphql \
  -o ./schema-gen \
  --generate

dab export ^
  --graphql ^
  -o .\schema-gen ^
  --generate

-m, --sampling-mode

Opções: TopNExtractor, EligibleDataSampler, TimePartitionedSampler Padrão: TopNExtractor

Example

dab export \
  --graphql \
  -o ./schema-gen \
  --generate \
  --sampling-mode TopNExtractor

dab export ^
  --graphql ^
  -o .\schema-gen ^
  --generate ^
  --sampling-mode TopNExtractor

-n, --sampling-count

• TopNExtractor: total de documentos
• EligibleDataSampler: por partição
• TimePartitionedSampler: por grupo de tempo

Os valores predefinidos dependem do modo:

• TopNExtractor: 10
• EligibleDataSampler: 5
• TimePartitionedSampler: 10

Example

dab export \
  --graphql \
  -o ./schema-gen \
  --generate \
  --sampling-mode TopNExtractor \
  --sampling-count 25

dab export ^
  --graphql ^
  -o .\schema-gen ^
  --generate ^
  --sampling-mode TopNExtractor ^
  --sampling-count 25

--sampling-partition-key-path

Caminho da chave de partição para EligibleDataSampler

Example

dab export \
  --graphql \
  -o ./schema-partitions \
  --generate \
  --sampling-mode EligibleDataSampler \
  --sampling-partition-key-path /customerId

dab export ^
  --graphql ^
  -o .\schema-partitions ^
  --generate ^
  --sampling-mode EligibleDataSampler ^
  --sampling-partition-key-path /customerId

-d, --sampling-days

Filtrar documentos por recenticidade (dias)

Os valores predefinidos dependem do modo:

• TopNExtractor: sem limite de tempo (padrão 0)
• EligibleDataSampler: 30
• TimePartitionedSampler: 10

Example

dab export \
  --graphql \
  -o ./schema-gen \
  --generate \
  --sampling-days 14

dab export ^
  --graphql ^
  -o .\schema-gen ^
  --generate ^
  --sampling-days 14

--sampling-group-count

Número de grupos de tempo para TimePartitionedSampler

Example

dab export \
  --graphql \
  -o ./schema-time \
  --generate \
  --sampling-mode TimePartitionedSampler \
  --sampling-group-count 8

dab export ^
  --graphql ^
  -o .\schema-time ^
  --generate ^
  --sampling-mode TimePartitionedSampler ^
  --sampling-group-count 8

-c, --config

Caminho do arquivo de configuração. Em caso de omissão:

1. dab-config.<DAB_ENVIRONMENT>.json se env var estiver definido
2. Caso contrário, dab-config.json

Example

dab export \
  --graphql \
  -o ./schema-out \
  --config ./dab-config.json

dab export ^
  --graphql ^
  -o .\schema-out ^
  --config .\dab-config.json

--help

Mostra o ecrã de ajuda.

Example

dab export --help

dab export --help

--version

Mostrar a informação da versão.

Example

dab export --version

dab export --version

Códigos de devolução

Examples

Exportar esquema existente

dab export \
  --graphql \
  -o ./schema-out

dab export ^
  --graphql ^
  -o .\schema-out

Gerar esquema (TopNExtractor)

dab export \
  --graphql \
  -o ./schema-gen \
  --generate \
  --sampling-mode TopNExtractor \
  --sampling-count 25 \
  --sampling-days 14

dab export ^
  --graphql ^
  -o .\schema-gen ^
  --generate ^
  --sampling-mode TopNExtractor ^
  --sampling-count 25 ^
  --sampling-days 14

Amostragem com reconhecimento de partição

dab export \
  --graphql \
  -o ./schema-partitions \
  --generate \
  --sampling-mode EligibleDataSampler \
  --sampling-partition-key-path /customerId \
  --sampling-count 10

dab export ^
  --graphql ^
  -o .\schema-partitions ^
  --generate ^
  --sampling-mode EligibleDataSampler ^
  --sampling-partition-key-path /customerId ^
  --sampling-count 10

Amostragem com base no tempo

dab export \
  --graphql \
  -o ./schema-time \
  --generate \
  --sampling-mode TimePartitionedSampler \
  --sampling-group-count 8 \
  --sampling-count 5 \
  --sampling-days 60

dab export ^
  --graphql ^
  -o .\schema-time ^
  --generate ^
  --sampling-mode TimePartitionedSampler ^
  --sampling-group-count 8 ^
  --sampling-count 5 ^
  --sampling-days 60

Nome do arquivo de saída personalizado

dab export \
  --graphql \
  -o ./out \
  -g cosmos-schema.gql \
  --generate \
  --sampling-mode TopNExtractor \
  --sampling-count 15

dab export ^
  --graphql ^
  -o .\out ^
  -g cosmos-schema.gql ^
  --generate ^
  --sampling-mode TopNExtractor ^
  --sampling-count 15

Utilização de ficheiros gerados

Define data-source.options.schema para o caminho do ficheiro de esquema exportado. Para mais informações, veja Configuração da Fonte de Dados.

Solução de problemas

Melhores práticas

• Comece com o TopNExtractor
• Usar o controle de versão para comparar alterações de esquema
• Para coleções críticas, execute várias passagens com parâmetros diferentes