registros uip df

Sintaxe e opções para "uip df Records", que gerencia linhas em uma entidade do Data Fabric, incluindo operações de registro único e em lote.

uip df records gerencia as linhas mantidas por uma entidade do Data Fabric. Os verbos cobrem leitura (list, get, query), gravação (insert, update, import, delete) e importação em massa de CSV. Os verbos de registro único retornam o registro afetado; os verbos em lote retornam contagens de sucesso/falha e saem diferentes de zero em falha parcial. list e query são compatíveis com paginação baseada em cursor.

Resumo

uip df records list <id> [-l <n>] [-o <n> | --cursor <cursor>] [--folder-key <key>]
uip df records get <id> <key> [--folder-key <key>]
uip df records insert <id> (-f <path> | --body <json>) [--folder-key <key>]
uip df records update <id> (-f <path> | --body <json>) [--folder-key <key>]
uip df records query <id> (-f <path> | --body <json>) [-l <n>] [-o <n> | --cursor <cursor>] [--folder-key <key>]
uip df records import <id> -f <csv-path> [--folder-key <key>]
uip df records delete <id> <key...> -y --reason <text> [--folder-key <key>]

Cada verbo também aceita --folder-key <key> (um GUID de pasta, para registros que pertencem a uma entidade com escopo de pasta).

Verbo

Texto	Finalidade
list	Lista os registros em uma entidade, com paginação baseada em cursor.
get	Obter um único registro por ID.
insert	Insira um registro (objeto) ou muitos (array).
update	Atualizar um registro (objeto) ou muitos (array); cada um deve incluir Id.
query	Filtrar, classificar, agregar e projetar registros usando um corpo de consulta JSON.
import	Importe registros em massa de um arquivo CSV.
delete	Exclua um ou mais registros por ID (destrutivo, requer -y/--reason).

lista de registros uip df

Listar os registros em uma entidade. Suporta paginação baseada em cursor.

Argumentos

Name	Required	Finalidade
<id>	sim	ID de entidade (UUID). Encontre-o com entities list.

Opções

Short	Long	Valor	Padrão	Description
-l	--limit	Número	50	Número de registros a serem retornados por página.
-o	--offset	Número	—	Comece da página que contém esse índice de registro (arredondado para baixo para um limite de página). mutuamente exclusivo com --cursor.
—	--cursor	Cursor	—	Valor do cursor de paginação de nextCursor.value de uma resposta anterior. Mutualmente exclusivo com --offset.
—	--folder-key	chave	—	Chave de pasta (GUID) da pasta que contém a entidade, para entidades com escopo de pasta.

Exemplos

uip df records list a1b2c3d4-0000-0000-0000-000000000001 --limit 2

# Continue paging — pass the string from the previous response's Data.nextCursor.value
uip df records list a1b2c3d4-0000-0000-0000-000000000001 \
    --cursor "eyJwYWdlIjoyfQ=="

# Just the IDs
uip df records list a1b2c3d4-0000-0000-0000-000000000001 \
    --output-filter 'Data.items[].Id'

Formato dos dados (--output json)

{
  "Code": "RecordList",
  "Data": {
    "items": [
      {
        "Id": "b2c3d4e5-0000-0000-0000-000000000001",
        "amount": 1500,
        "notes": "HasValue=true Length=20000"
      },
      { "Id": "b2c3d4e5-0000-0000-0000-000000000002", "amount": 2750, "notes": null }
    ],
    "totalCount": 2,
    "hasNextPage": false
  }
}

Importante:

As chaves do envelope de paginação (items, totalCount, hasNextPage e — quando existir outra página — nextCursor, previousCursor, currentPage, totalPages) são CamelCase, ao contrário das próprias Id . Quando hasNextPage for true, passe Data.nextCursor.value (uma string) de volta como --cursor — não todo o objeto nextCursor.

Um campo MULTILINE_MAX em list retorna apenas um marcador de tamanho ("HasValue=true Length=20000" ou null se vazio), não o texto completo — leia o valor completo com get abaixo.

registros uip df obter

Obter um único registro por ID.

Argumentos

Name	Required	Finalidade
<id>	sim	ID de entidade (UUID).
<key>	sim	ID de registro (UUID).

Opções

Short	Long	Valor	Padrão	Description
—	--folder-key	chave	—	Chave de pasta (GUID) da pasta que contém a entidade, para entidades com escopo de pasta.

Exemplo

uip df records get a1b2c3d4-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000001

Formato dos dados (--output json)

{
  "Code": "RecordDetails",
  "Data": {
    "Id": "b2c3d4e5-0000-0000-0000-000000000001",
    "amount": 1500,
    "status": "Paid"
  }
}

Ao contrário de list, um campo MULTILINE_MAX aqui retorna seu valor completo, não um marcador de tamanho.

inserção de registros uip df

Insira um ou mais registros. A entrada pode ser um único objeto JSON ou um array de objetos.

Argumentos

Name	Required	Finalidade
<id>	sim	ID de entidade (UUID).

Opções

Short	Long	Valor	Padrão	Description
-f	--file	Path	—	Caminho para o arquivo JSON com dados de registro (objeto ou array de objetos).
—	--body	JSON	—	Dados de registro JSON incorporados (use - para ler a partir de stdin).
—	--folder-key	chave	—	Chave de pasta (GUID) da pasta que contém a entidade, para entidades com escopo de pasta.

Valores de campo para tipos especiais:

• CHOICE_SET_SINGLE o numberId do valor de escolha (um número inteiro, não a string de nome) — procure ele com df choice-sets list-values <id>.
• CHOICE_SET_MULTIPLE uma matriz de numberId inteiros.
• RELATIONSHIP sempre o Id do registro de destino (um UUID), independentemente de qual referenceFieldId o esquema usa para a junção — referenceFieldId configura apenas a junção, não é o valor armazenado.
• FILE — não pode ser definido por meio de insert/update; o campo é detectado automaticamente do esquema da entidade e rejeitado se estiver presente na carga. Preencha-o posteriormente com uip df files upload.

Exemplos

# Single record
uip df records insert a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"amount":1500,"status":"New"}'

# Choice-set and relationship fields
uip df records insert a1b2c3d4-0000-0000-0000-000000000004 \
    --body '{"category":0,"tags":[1,3],"submitter":"e1f2a3b4-0000-0000-0000-000000000001","amount":250}'

# Batch from file
uip df records insert a1b2c3d4-0000-0000-0000-000000000001 \
    --file ./invoices.json

Formato dos dados (--output json)

A inserção de registro único retorna Code: "RecordInserted" com o registro criado. A inserção em lote retorna Code: "RecordsBatchInserted":

{
  "Code": "RecordsBatchInserted",
  "Data": {
    "SuccessCount": 1,
    "FailureCount": 0,
    "SuccessRecords": [ { "Id": "b2c3d4e5-0000-0000-0000-000000000010" } ],
    "FailureRecords": []
  }
}

Se algum registro falhar em um lote, o comando sairá diferente de zero enquanto ainda emitindo o resultado completo.

Atualização de registros uip df

Atualize um ou mais registros. Cada registro deve incluir um campo Id (ou id).

Argumentos

Name	Required	Finalidade
<id>	sim	ID de entidade (UUID).

Opções

Short	Long	Valor	Padrão	Description
-f	--file	Path	—	Caminho para o arquivo JSON com dados de registro (deve incluir o campo Id ).
—	--body	JSON	—	Dados do registro JSON incorporado (deve incluir o campo Id; use - para ler a partir de stdin).
—	--folder-key	chave	—	Chave de pasta (GUID) da pasta que contém a entidade, para entidades com escopo de pasta.

Exemplo

uip df records update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"Id":"b2c3d4e5-0000-0000-0000-000000000001","status":"Paid"}'

Formato dos dados (--output json)

Atualizações únicas emitam Code: "RecordUpdated"; atualizações em lote emite Code: "RecordsBatchUpdated" com o mesmo formato que RecordsBatchInserted. Os campos Id ausentes falham com Failure antes de qualquer gravação.

consulta de registros uip df

Consulte registros com filtragem, classificação, agregação e seleção de campos. Suporta paginação baseada em cursor. O corpo é um objeto JSON com chaves opcionais, filterGroup, sortOptions, selectedFields, aggregates, e groupBy.

Argumentos

Name	Required	Finalidade
<id>	sim	ID de entidade (UUID).

Opções

Short	Long	Valor	Padrão	Description
-f	--file	Path	—	Caminho para o arquivo JSON com opções de consulta.
—	--body	JSON	—	Opções de consulta JSON embutidas (use - para ler a partir de stdin).
-l	--limit	Número	50	Tamanho da página
-o	--offset	Número	—	Comece da página que contém esse índice de registro. mutuamente exclusivo com --cursor.
—	--cursor	Cursor	—	Valor do cursor de paginação de nextCursor.value de uma resposta anterior.
—	--folder-key	chave	—	Chave de pasta (GUID) da pasta que contém a entidade, para entidades com escopo de pasta.

Chaves de corpo de consulta

• filterGroup — { "logicalOperator": "AND" | "OR" | 0 | 1, "queryFilters": [...], "filterGroups": [...] }. logicalOperator aceita a forma de string (sem diferença entre maiúsculas e minúsculas) ou a forma de número inteiro (0 = AND, 1 = OR); filterGroups aninha grupos do mesmo formato para condições compostas.

• queryFilters entradas são { "fieldName": "<field>", "operator": "<op>", "value": ... } (ou "valueList": [...] para in/not in). fieldName deve começar com uma letra e conter apenas letras, dígitos, sublinhados e pontos.

  Importante:

  Os operadores compatíveis são exatamente: =, !=, >, <, >=, <=, contains, not contains, startswith, endswith, in, not in. Não há eq, ==, Equals, like, BETWEEN, ou operador regex — o servidor rejeita qualquer coisa fora desse conjunto. Componha um ENTRE como >= + <= no mesmo grupo queryFilters.

• sortOptions — matriz de { "fieldName": "<field>", "isDescending": true | false }.

• selectedFields Array de nomes de campos para o projeto.

• aggregates — Array de até 5 objetos { "function": "COUNT" | "SUM" | "AVG" | "MIN" | "MAX", "field": "<field>", "alias": "<name>" } . alias é opcional e, quando fornecido, deve começar com uma letra (somente letras, dígitos, sublinhados, ≥ 128 caracteres).

• groupBy Array de até 5 nomes de campos para agrupar os agregados.

Exemplos

# Filter by status
uip df records query a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"filterGroup":{"logicalOperator":0,"queryFilters":[{"fieldName":"status","operator":"=","value":"Paid"}]}}'

# Sort newest first, project two fields
uip df records query a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"sortOptions":[{"fieldName":"createdAt","isDescending":true}],"selectedFields":["Id","amount"]}'

# Aggregate — COUNT grouped by a field
uip df records query a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"aggregates":[{"function":"COUNT","field":"Id","alias":"total"}],"groupBy":["status"]}'

Formato dos dados (--output json)

{
  "Code": "RecordQuery",
  "Data": {
    "items": [ { "Id": "b2c3d4e5-0000-0000-0000-000000000001", "status": "Paid" } ],
    "totalCount": 1,
    "hasNextPage": false
  }
}

As linhas de uma consulta agregada carregam os valores de campo groupBy mais o alias de cada agregado em vez de campos de registro completos:

{
  "Code": "RecordQuery",
  "Data": {
    "items": [
      { "status": "Paid", "total": 12 },
      { "status": "Pending", "total": 3 }
    ]
  }
}

importação de registros uip df

Importe registros em massa de um arquivo CSV.

Argumentos

Name	Required	Finalidade
<id>	sim	ID de entidade (UUID).

Opções

Short	Long	Valor	Padrão	Description
-f	--file	Path	necessário	Caminho para o arquivo CSV a ser importado.
—	--folder-key	chave	—	Chave de pasta (GUID) da pasta que contém a entidade, para entidades com escopo de pasta.

Exemplo

uip df records import a1b2c3d4-0000-0000-0000-000000000001 \
    --file ./invoices.csv

Formato dos dados (--output json)

{
  "Code": "RecordsImported",
  "Data": {
    "InsertedRecords": 42,
    "TotalRecords": 42
  }
}

Se o servidor registrar erros no nível da linha, a resposta também inclui ErrorFileLink apontando para um relatório de erros que pode ser baixado.

exclusão de registros uip df

Exclua um ou mais registros por ID. Isso é irreversível.

Argumentos

Name	Required	Finalidade
<id>	sim	ID de entidade (UUID).
<key...>	sim	Um ou mais IDs de registro a serem excluídos.

Opções

Short	Long	Valor	Padrão	Description
-y	--yes	Bandeira	—	Obrigatório. Confirma que esta é uma operação irreversível.
—	--reason	text	—	Obrigatório. Motivo da exclusão — retornado na resposta para que o chamador possa registrá-lo.
—	--folder-key	chave	—	Chave de pasta (GUID) da pasta que contém a entidade, para entidades com escopo de pasta.

Exemplos

uip df records delete a1b2c3d4-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000001 \
    --yes --reason "test cleanup"

# Bulk delete
uip df records delete a1b2c3d4-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000001 \
    b2c3d4e5-0000-0000-0000-000000000002 \
    b2c3d4e5-0000-0000-0000-000000000003 \
    --yes --reason "test cleanup"

Formato dos dados (--output json)

{
  "Code": "RecordsDeleted",
  "Data": {
    "SuccessCount": 1,
    "FailureCount": 0,
    "SuccessRecords": [ { "Id": "b2c3d4e5-0000-0000-0000-000000000001" } ],
    "FailureRecords": [],
    "Reason": "test cleanup"
  }
}

Uma falha parcial ainda emite a resposta completa, mas define o código de saída 1

Relacionado

• uip df entities — descubra o ID da entidade primeiro; inspecione o esquema antes de criar consultas.
• uip df files — gerencie anexos de arquivo nos registros aqui.
• uip df choice-sets — pesquise valores numberId para campos CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE .

Veja também

• Visão geral da ferramenta Data Fabric
• Opções globais
• Códigos de saída