Anpassen von Tabellen und Spalten

Das SDK unterstützt Erstellungs-, Aktualisierungs- und Löschvorgänge (CUD) für benutzerdefinierte Tabellen und Spalten, optionale Lösungszuordnung sowie Abrufen und Listentabellendefinitionen.

Sehen wir uns Beispielcode für die Arbeit mit einer benutzerdefinierten Tabelle an.

# Create a custom table, including the customization prefix value in the schema names for the table and columns.
table_info = client.tables.create("new_Product", {
    "new_Code": "string",
    "new_Description": "memo",
    "new_Price": "decimal",
    "new_Active": "bool"
})

# Create with custom primary column name and solution assignment
table_info = client.tables.create(
    "new_Product",
    columns={
        "new_Code": "string",
        "new_Price": "decimal"
    },
    solution="MyPublisher",  # Optional: add to specific solution
    primary_column="new_ProductName",  # Optional: custom primary column (default is "{customization prefix value}_Name")
)

# Get table information
info = client.tables.get("new_Product")
print(f"Logical name: {info['table_logical_name']}")
print(f"Entity set: {info['entity_set_name']}")

# List all tables
tables = client.tables.list()
for table in tables:
    print(table)

# Add columns to existing table (columns must include customization prefix value)
client.tables.add_columns("new_Product", {"new_Category": "string"})

# Remove columns
client.tables.remove_columns("new_Product", ["new_Category"])

# List all columns (attributes) for a table to discover schema
columns = client.tables.list_columns("account")
for col in columns:
    print(f"{col['LogicalName']} ({col.get('AttributeType')})")

# List only specific properties
columns = client.tables.list_columns(
    "account",
    select=["LogicalName", "SchemaName", "AttributeType"],
    filter="AttributeType eq 'String'",
)

# Clean up
client.tables.delete("new_Product")

Unterstützte Spaltentypen

Die folgenden Typ-Strings werden von create() und add_columns() akzeptiert.

Typ Akzeptierte Aliase
string text
memo multiline
int integer
decimal money
float double
bool boolean
datetime date
file —

Übergeben Sie für Optionsetspalten (Auswahlspalten) eine IntEnum Unterklasse (oder ein Enum Element mit ganzzahligen Werten) direkt als Spaltentypwert anstelle einer Zeichenfolge. Das SDK verwendet die Klassenmitglieder, um die Optionssatzwerte zu definieren.

from enum import IntEnum

class Priority(IntEnum):
    LOW = 1
    MEDIUM = 2
    HIGH = 3

table_info = client.tables.create("new_Task", {
    "new_Title": "string",
    "new_Priority": Priority,   # optionset column
})

TableInfo-Rückgabeobjekt

Die client.tables.create() -Methode gibt ein TableInfo -Objekt zurück. Greifen Sie direkt auf die Eigenschaften zu, oder verwenden Sie die alte Dictionary-Key-Notation zur Wahrung der Abwärtskompatibilität.

table_info = client.tables.create("new_Product", {"new_Code": "string"})

print(table_info.schema_name)       # new_Product
print(table_info.logical_name)      # new_product
print(table_info.entity_set_name)   # new_products
print(table_info.columns_created)   # ['new_Code', ...]

# Legacy dict-key access still works
print(table_info["table_schema_name"])

Die add_columns()- und remove_columns()-Methoden geben die Liste der Namen der Spaltenschemas zurück, die sie erstellen oder entfernen. Die get() Methode gibt Tabellenmetadaten zurück oder None wenn die Tabelle nicht vorhanden ist, wodurch sie für Existenzprüfungen nützlich ist.

Alternativschlüssel

Ein alternativer Schlüssel identifiziert einen Datensatz anhand einer oder mehrerer geschäftlicher Spalten anstelle einer von Dataverse generierten GUID. Alternative Schlüssel sind für Upsert-Vorgänge erforderlich. Definieren Sie sie im Power Apps Maker-Portal unter Tabelle>Schlüssel oder programmgesteuert mithilfe von client.tables.create_alternate_key.

# Create an alternate key on the accountnumber column
key = client.tables.create_alternate_key(
    "account",
    "account_accountnumber_ak",
    ["accountnumber"],
    display_name="Account Number",
)
print(f"Created key {key.schema_name} ({key.metadata_id}), status={key.status}")

# The key status transitions from Pending to Active asynchronously - poll before upserting
for k in client.tables.get_alternate_keys("account"):
    if k.schema_name == "account_accountnumber_ak":
        print(f"{k.schema_name}: {k.status}")

Important

Der Übergang von Pending zu Active erfolgt nicht sofort. Überprüfen Sie den Schlüsselstatus direkt nach der Erstellung und warten Sie, bis sein Status Active lautet, bevor Sie Upsert-Anfragen ausgeben. Ohne einen aktiven alternativen Schlüssel lehnt Dataverse Upsert-Anforderungen mit einem Fehler von 400 ab.

Important

Alle benutzerdefinierten Spaltennamen müssen den Präfixwert der Anpassung enthalten (z. B. "new_"). Diese Anforderung stellt eine explizite, vorhersagbare Benennung sicher und entspricht den Dataverse-Metadatenanforderungen.

Weitere Informationen zum Arbeiten mit benutzerdefinierten Tabellenmetadaten:

  • tables.create gibt ein TableInfo Objekt zurück, das die neue Tabelle beschreibt. Es werden keine Datensatz-IDs zurückgegeben.
  • tables.get gibt None zurück, wenn die Tabelle nicht existiert, sodass die Schema-Einrichtung idempotent wird.
  • tables.add_columns und tables.remove_columns geben Sie die Liste der geänderten Spaltennamen zurück.
  • tables.list_columns gibt Rohmetadaten-Wörterbücher für Attribute zurück, die die PascalCase-Eigenschaftsnamen der Web-API verwenden, wie LogicalName und AttributeType.

Informationen zum Erstellen, Lesen, Aktualisieren und Löschen von Datensätzen in einer Tabelle finden Sie unter "Arbeiten mit Daten".

Siehe auch

  • Last updated on