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 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. Lista e consulta suportam paginação baseada em cursor.

Resumo

uip df records <verb> [options]

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 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.

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
-t	--tenant	name	padrão da sessão	Substituir o tenant.
-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	—	Cursor de paginação de uma resposta anterior.

Exemplos

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

# Continue paging
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.Records[].Id'

Formato dos dados (--output json)

{
  "Code": "RecordList",
  "Data": {
    "TotalCount": 2,
    "Records": [
      { "Id": "b2c3d4e5-0000-0000-0000-000000000001", "amount": 1500 }
    ],
    "HasNextPage": false
  }
}

Quando existirem mais páginas, a resposta também carregará NextCursor, CurrentPage e TotalPages. Transmita NextCursor de volta como --cursor para continuar.

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
-t	--tenant	name	padrão da sessão	Substituir o tenant.

Exemplos

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"
  }
}

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
-t	--tenant	name	padrão da sessão	Substituir o tenant.
-f	--file	Path	—	Caminho para o arquivo JSON com dados de registro (objeto ou array de objetos).
—	--body	JSON	—	Dados de registro JSON incorporados.

Exemplos

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

# 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
-t	--tenant	name	padrão da sessão	Substituir o tenant.
-f	--file	Path	—	Caminho para o arquivo JSON com dados de registro (deve incluir o campo Id ).
—	--body	JSON	—	Dados do registro JSON incorporados (deve incluir o campo Id ).

Exemplos

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 opções de filtro, classificação e seleção de campo. Suporta paginação baseada em cursor. O corpo é um objeto JSON com chaves opcionais filterGroup, sortOptions (array de { fieldName, isDescending }) e selectedFields (array de nomes).

Argumentos

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

Opções

Short	Long	Valor	Padrão	Description
-t	--tenant	name	padrão da sessão	Substituir o tenant.
-f	--file	Path	—	Caminho para o arquivo JSON com opções de consulta.
—	--body	JSON	—	Opções de consulta JSON embutidas.
-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	—	Cursor de paginação de uma resposta anterior.

Exemplos

# Filter by status
uip df records query a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"filterGroup":{"field":"status","operator":"eq","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"]}'

Formato dos dados (--output json)

{
  "Code": "RecordQuery",
  "Data": {
    "TotalCount": 2,
    "Records": [ { "Id": "b2c3d4e5-0000-0000-0000-000000000001", "amount": 1500 } ],
    "HasNextPage": false
  }
}

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
-t	--tenant	name	padrão da sessão	Substituir o tenant.
-f	--file	Path	necessário	Caminho para o arquivo CSV a ser importado.

Exemplos

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.

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
-t	--tenant	name	padrão da sessão	Substituir o tenant.

Exemplos

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

# 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

Formato dos dados (--output json)

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

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.

Veja também

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