entidades df uip

Sintaxis y opciones para `entidades uip df`, que explora y muta los esquemas de entidad de Data Fabric.

uip df entities busca y muta los esquemas de entidad de Data Fabric. Una entidad es un modelo de datos con tipo: una forma de fila con campos y tipos con nombre. Los verbos cubren el descubrimiento (list, get), la creación (create, update) y la eliminación (delete); operaciones en el nivel de registro activas en uip df records.

Sinopsis

uip df entities list [--native-only] [--folder-key <key> | --include-folders]
uip df entities get <id> [--folder-key <key>]
uip df entities create <name> (-f <path> | --body <json>) [--folder-key <key>]
uip df entities update <id> (-f <path> | --body <json>) [-y --reason <text>] [--folder-key <key>]
uip df entities delete <id> -y --reason <text> [--folder-key <key>]

Verbos

Verbo	Propósito
list	Enumerar entidades. Los valores predeterminados son entidades a nivel de tenant; --folder-key ámbitos a una carpeta, --include-folders incluye las entidades de cada carpeta junto con las del nivel de tenant.
get	Devuelve el esquema (incluidos todos los campos) de una sola entidad.
create	Crea una nueva entidad a partir de una definición JSON.
update	Actualizar los metadatos o el esquema de una entidad: añadir campos, actualizar los metadatos de los campos o eliminar campos (destructivo, requiere -y/--reason).
delete	Eliminar una entidad directamente (destructivo, requiere -y/--reason).

--folder-key, --native-only, --include-folders

--folder-key <key> (un GUID de carpeta) limita el ámbito de un verbo a una entidad en el nivel de carpeta en lugar del tenant. Se acepta en todos los verbos de este grupo. En list, es mutuamente excluyente con --include-folders (que enumera las entidades a nivel de tenant junto con las entidades de cada carpeta en una llamada). --native-only (solo en list) filtra las entidades federadas: aquellas respaldadas por una conexión de conector externo (identificadas por una matriz externalFields no vacía).

lista de entidades de uip df

Enumerar entidades de Data Fabric.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--native-only	Marca	Desactivado	Mostrar solo entidades nativas; excluir las entidades federadas con conexiones externas.
—	--folder-key	clave	—	Clave de carpeta (GUID) para establecer el ámbito del listado en una carpeta específica. Mutuamente exclusivo con --include-folders.
—	--include-folders	Marca	Desactivado	Enumera las entidades a nivel de tenant junto con las entidades de cada carpeta que puedas ver. Mutuamente exclusivo con --folder-key.

Ejemplos

uip df entities list --native-only

uip df entities list --folder-key f1000000-0000-0000-0000-000000000001

Forma de datos (--json de salida)

{
  "Code": "EntityList",
  "Data": [
    {
      "id": "a1b2c3d4-0000-0000-0000-000000000001",
      "name": "Invoice",
      "displayName": "Invoice",
      "entityType": "Standard",
      "description": "Invoice records",
      "folderId": "f1000000-0000-0000-0000-000000000001",
      "isRbacEnabled": false,
      "fields": [
        { "id": "f1000000-0000-0000-0000-000000000001", "name": "amount" }
      ],
      "externalFields": []
    }
  ]
}

Importante:

Data filas aquí son los objetos SDK sin procesar, en camelCase — a diferencia de la respuesta de get a continuación, list no PascalCase no da nombre a los campos ni reforma la carga útil. folderId de cada fila es el valor a pasar como --folder-key en los comandos de seguimiento dirigidos a esa entidad.

las entidades uip df obtienen

Devuelve el esquema de una sola entidad, incluidos todos los campos.

Argumentos

Nombre	Obligatorio	Propósito
<id>	Sí	ID de entidad (UUID). Encuéntralo con entities list.

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
—	--folder-key	clave	—	Clave de carpeta (GUID) de la carpeta que contiene la entidad, para entidades de ámbito de carpeta.

Ejemplo

uip df entities get a1b2c3d4-0000-0000-0000-000000000001

Forma de datos (--json de salida)

{
  "Code": "EntitySchema",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Name": "Invoice",
    "DisplayName": "Invoice",
    "EntityType": "Standard",
    "Description": "Invoice records",
    "IsRbacEnabled": false,
    "Fields": [
      {
        "Id": "f1000000-0000-0000-0000-000000000002",
        "Name": "amount",
        "DisplayName": "Amount",
        "FieldDataType": {
          "Name": "DECIMAL",
          "DecimalPrecision": 2,
          "MinValue": 0,
          "MaxValue": 999999
        },
        "IsRequired": true,
        "IsUnique": false,
        "IsEncrypted": false,
        "IsRbacEnabled": false,
        "IsPrimaryKey": false,
        "IsSystemField": false
      }
    ]
  }
}

A diferencia de list, esta respuesta es PascalCase. El nombre de tipo de un campo y sus restricciones (DecimalPrecision, MinValue, MaxValue, LengthLimit, etc., dependiendo del tipo) viven anidados en FieldDataType, no como propiedades planas en el campo.

creación de entidades uip df

Crear una nueva entidad. El nombre de la entidad debe comenzar con una letra y contener solo letras, números y guiones bajos. Pasa la definición en línea (--body) o desde un archivo (--file).

Argumentos

Nombre	Obligatorio	Propósito
<name>	Sí	Nombre de la entidad (comienza con una letra; solo letras, números, guiones bajos).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-f	--file	Ruta	—	Ruta a un archivo JSON con la definición de la entidad (matriz fields necesaria; displayName, description, isRbacEnabled, isAnalyticsEnabled opcional).
—	--body	JSON	—	Definición de entidad JSON en línea, misma forma que --file.
—	--folder-key	clave	—	Clave de carpeta (GUID) de la carpeta de destino, para crear una entidad de ámbito de carpeta en lugar de una a nivel de tenant.

Objeto de definición de entidad:

{
  "displayName": "Invoice",
  "description": "Invoice records",
  "isRbacEnabled": false,
  "fields": [
    { "name": "title", "type": "STRING" }
  ]
}

Importante:

Cada objeto de campo requiere name, no fieldName : pasar fieldName falla con el error de validación Each field must include a 'name' string. Un objeto de campo copiado textualmente de la salida de entities get (que utiliza Name/FieldDataType, PascalCase) también se acepta aquí y se normaliza automáticamente a esta forma de escritura plana.

Los valores type válidos provienen del enum EntityFieldDataType del SDK: un tipo no válido falla con un ValidationError que enumera el conjunto completo permitido. Más allá de los tipos escalares simples (STRING, DECIMAL, GUID, BOOLEAN, DATE, DATETIME, …), varios tipos toman propiedades adicionales requeridas en el objeto de campo:

Tipo	Propiedades adicionales requeridas
CHOICE_SET_SINGLE / CHOICE_SET_MULTIPLE	choiceSetId — UUID de df choice-sets list.
RELATIONSHIP	referenceEntityId (UUID de la entidad de destino, de entities list) y referenceFieldId (UUID de un campo en la entidad de destino, de entities get <target-id>). Opcionalmente, referenceFolderKey cuando la entidad de destino vive en una carpeta diferente.
FILE	Solo name y type: el servidor conecta automáticamente la referencia del archivo adjunto interno. Rellene el valor más tarde con uip df files upload.
MULTILINE_MAX	lengthLimit Opcional (presupuesto de bytes UTF-16, 1–131072; el valor predeterminado es aproximadamente 65 536 caracteres). No filtrable ni ordenable; records list/query devuelve solo un marcador de tamaño para él: lee el contenido completo con records get. Cerrado por el marcador de característica MultilineMax del tenant.

Una columna RELATIONSHIP en un registro siempre almacena el Id del registro de destino (un UUID), independientemente de qué referenceFieldId configuró la unión; consulta records insert para saber cómo escribir el valor.

Ejemplos

uip df entities create Invoice --file ./invoice.entity.json

uip df entities create Invoice \
    --body '{"displayName":"Invoice","fields":[{"name":"amount","type":"DECIMAL"}]}'

# choice-set, relationship, file, and large-text fields
uip df entities create Expense \
    --body '{"displayName":"Expense","fields":[{"name":"category","type":"CHOICE_SET_SINGLE","choiceSetId":"c1d2e3f4-0000-0000-0000-000000000001","isRequired":true},{"name":"submitter","type":"RELATIONSHIP","referenceEntityId":"a1b2c3d4-0000-0000-0000-000000000010","referenceFieldId":"f1000000-0000-0000-0000-000000000100","isRequired":true},{"name":"receipt","type":"FILE"},{"name":"notes","type":"MULTILINE_MAX"}]}'

Forma de datos (--json de salida)

{
  "Code": "EntityCreated",
  "Data": { "ID": "a1b2c3d4-0000-0000-0000-000000000001" }
}

actualización de entidades de uip df

Actualizar los metadatos o el esquema de una entidad. El cuerpo acepta addFields, updateFields, removeFields, displayName, description y isAnalyticsEnabled/isRbacEnabled. La entidad name en sí es inmutable: no se puede incluir en el cuerpo de la actualización.

Argumentos

Nombre	Obligatorio	Propósito
<id>	Sí	ID de entidad (UUID).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-f	--file	Ruta	—	Ruta al archivo JSON con opciones de actualización.
—	--body	JSON	—	Opciones de actualización de JSON en línea.
-y	--yes	Marca	—	Obligatorio cuando removeFields no está vacío : reconoce que la eliminación del campo es irreversible.
—	--reason	text	—	Obligatorio cuando removeFields no está vacío : se repite en la respuesta para que la persona que llama pueda registrarlo.
—	--folder-key	clave	—	Clave de carpeta (GUID) de la carpeta que contiene la entidad, para entidades de ámbito de carpeta.

• addFields — matriz de nuevos campos, forma de escritura plana (name + type, más extras específicos del tipo — consulta la sección create anterior). Un objeto de campo copiado de entities get también se acepta y se normaliza.
• updateFields — matriz tecleada por el campo id (de entities get), con las propiedades de los metadatos cambiadas (por ejemplo displayName, description, isRequired, isRbacEnabled, isEncrypted, isHiddenField, defaultValue, restricciones). No pegue un objeto de campo copiado completo aquí: pase id más solo las propiedades planas que se cambian. updateFields no puede cambiar el type de un campo o su configuración isUnique.
• removeFields — matriz de objetos {"name": "<fieldName>"} , identificados por nombre, no por id. Requiere -y/--yes y --reason "<text>": la operación elimina los valores almacenados del campo y no se puede deshacer.
• La actualización de los metadatos de la entidad (description, isRbacEnabled, isAnalyticsEnabled) requiere que displayName también esté presente en el mismo cuerpo, incluso si no ha cambiado. Obtenga primero el displayName actual con entities get si no lo hace ya lo tienes.

Ejemplos

# Add a field
uip df entities update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"addFields":[{"name":"note","type":"STRING","lengthLimit":200}]}'

# Rename an existing field's display name
uip df entities update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"updateFields":[{"id":"f1000000-0000-0000-0000-000000000002","displayName":"Amount (USD)","isRequired":true}]}'

# Remove a field — destructive, requires --yes and --reason
uip df entities update a1b2c3d4-0000-0000-0000-000000000001 \
    --body '{"removeFields":[{"name":"oldColumn"}]}' \
    --yes --reason "quarterly cleanup"

Forma de datos (--json de salida)

{
  "Code": "EntityUpdated",
  "Data": { "ID": "a1b2c3d4-0000-0000-0000-000000000001" }
}

Cuando la actualización incluye removeFields, la respuesta también refleja lo que se eliminó:

{
  "Code": "EntityUpdated",
  "Data": {
    "ID": "a1b2c3d4-0000-0000-0000-000000000001",
    "RemovedFields": ["oldColumn"],
    "Reason": "quarterly cleanup"
  }
}

eliminación de entidades uip df

Eliminar una entidad directamente. Esto es irreversible y elimina el esquema de la entidad junto con todos sus registros.

Argumentos

Nombre	Obligatorio	Propósito
<id>	Sí	ID de entidad (UUID).

Opciones

Corto	Largo	Valor	Predeterminado	Descripción
-y	--yes	Marca	—	Obligatorio. Confirma que se trata de una operación irreversible.
—	--reason	text	—	Obligatorio. Motivo de la eliminación: se repite en la respuesta para que la persona que llama pueda registrarlo.
—	--folder-key	clave	—	Clave de carpeta (GUID) de la carpeta que contiene la entidad, para entidades de ámbito de carpeta.

Ejemplo

uip df entities delete a1b2c3d4-0000-0000-0000-000000000001 \
    --yes --reason "test entity cleanup"

Forma de datos (--json de salida)

{
  "Code": "EntityDeleted",
  "Data": {
    "Id": "a1b2c3d4-0000-0000-0000-000000000001",
    "Reason": "test entity cleanup"
  }
}

Relacionado

• uip df records : gestiona las filas de estas entidades.
• uip df files : archivos adjuntos en registros.
• uip df choice-sets : los conjuntos de opciones referenciados por los campos CHOICE_SET_SINGLE/CHOICE_SET_MULTIPLE .
• uip vss generate : genera tipos de TypeScript a partir de una exportación de esquema de Data Fabric.

Ver también

• Descripción general de la herramienta Data Fabric
• Opciones globales
• Códigos de salida