Freigeben über


auto-config-Befehl

Erstellen oder Aktualisieren einer autoentities Definition in einer vorhandenen Konfigurationsdatei des Daten-API-Generators. Autoentities definieren Sie musterbasierte Regeln, die beim Start automatisch übereinstimmende Datenbankobjekte als DAB-Entitäten verfügbar machen.

Weitere Informationen finden Sie unter "Automatische Konfiguration".

Syntax

dab auto-config <definition-name> [options]

Schnellblick

Auswahl Zusammenfassung
-c, --config Konfigurationsdateipfad. Standard-dab-config.json.

Kopfabschnitt

Auswahl Zusammenfassung
<definition-name> Erforderlich. Name der autoentities zu konfigurierenden Definition.
--patterns.include T-SQL-Muster LIKE , um Datenbankobjekte einzuschließen. Standardwert: %.%.
--patterns.exclude T-SQL-Muster LIKE zum Ausschließen von Datenbankobjekten. Standardwert: null.
--patterns.name Interpolationssyntax für die Entitätsbenennung. Standardwert: {object}.
--permissions Berechtigungen im role:actions Format. Standardwert: null.

Vorlagenabschnitt

Auswahl Zusammenfassung
--template.rest.enabled Aktivieren/Deaktivieren von REST für übereinstimmene Entitäten. Standardwert: true.
--template.graphql.enabled Aktivieren/Deaktivieren von GraphQL für übereinstimmene Entitäten. Standardwert: true.
--template.mcp.dml-tool Aktivieren/Deaktivieren von MCP-Tools (Model Context Protocol) für datenmanipulationssprache (DML) für übereinstimmende Entitäten. Standardwert: true.
--template.health.enabled Aktivieren/Deaktivieren von Integritätsprüfungen für übereinstimmene Entitäten. Standardwert: true.
--template.cache.enabled Aktivieren/Deaktivieren der Zwischenspeicherung für übereinstimmene Entitäten. Standardwert: false.
--template.cache.ttl-seconds Zwischenspeichern von Zeit-zu-Live-Zeit in Sekunden. Standardwert: null.
--template.cache.level Cacheebene. Zulässige Werte: L1, L1L2. Standardwert: L1L2.

<definition-name>

Erforderliches Positionsargument. Logischer Name der autoentities Definition. Groß-/Kleinschreibung wird beachtet, Wenn die Definition bereits vorhanden ist, aktualisiert DAB sie; andernfalls erstellt DAB sie.

Beispiel

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --permissions "anonymous:read"

Resultierende Konfiguration

{
  "autoentities": {
    "my-def": {
      "patterns": {
        "include": [ "dbo.%" ]
      },
      "permissions": [
        { 
          "role": "anonymous", 
          "actions": [ { "action": "read" } ] 
        }
      ]
    }
  }
}

-c, --config

Pfad zur Konfigurationsdatei. Der Standardwert ist, dab-config.json sofern nicht dab-config.<DAB_ENVIRONMENT>.json vorhanden, wobei DAB_ENVIRONMENT es sich um eine Umgebungsvariable handelt.

Beispiel

dab auto-config my-def \
  --config ./dab-config.json \
  --patterns.include "dbo.%"

Resultierende Konfiguration

{
  "autoentities": {
    "my-def": {
      "patterns": {
        "include": [ "dbo.%" ]
      }
    }
  }
}

--patterns.include

T-SQL-Muster LIKE , um Datenbankobjekte einzuschließen. Durch Leerzeichen getrenntes Array. Das Musterformat ist schema.object (z. B dbo.%. ). Standardwert: %.%.

Beispiel

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --permissions "anonymous:read"

Resultierende Konfiguration

{
  "autoentities": {
    "my-def": {
      "patterns": {
        "include": [ "dbo.%" ]
      },
      "permissions": [
        { 
          "role": "anonymous", 
          "actions": [ { "action": "read" } ] 
        }
      ]
    }
  }
}

--patterns.exclude

T-SQL-Muster LIKE zum Ausschließen von Datenbankobjekten. Durch Leerzeichen getrenntes Array. Ausschlussmuster werden nach einschließen von Mustern ausgewertet. Standardwert: null.

Beispiel

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --patterns.exclude "dbo.internal%" \
  --permissions "anonymous:read"

Resultierende Konfiguration

{
  "autoentities": {
    "my-def": {
      "patterns": {
        "include": [ "dbo.%" ],
        "exclude": [ "dbo.internal%" ]
      },
      "permissions": [
        { 
          "role": "anonymous", 
          "actions": [ { "action": "read" } ] 
        }
      ]
    }
  }
}

--patterns.name

Interpolationssyntax für die Entitätsbenennung. Unterstützt {schema} und {object} Platzhalter. Muss für jede generierte Entität eindeutig sein. Standardwert: {object}.

Beispiel

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --patterns.name "{schema}_{object}" \
  --permissions "anonymous:read"

Resultierende Konfiguration

{
  "autoentities": {
    "my-def": {
      "patterns": {
        "include": [ "dbo.%" ],
        "name": "{schema}_{object}"
      },
      "permissions": [
        { 
          "role": "anonymous", 
          "actions": [ { "action": "read" } ] 
        }
      ]
    }
  }
}

--permissions

Berechtigungen für alle übereinstimmenen Entitäten im role:actions Format. Standardwert: null.

Beispiel

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --permissions "anonymous:read"

Resultierende Konfiguration

{
  "autoentities": {
    "my-def": {
      "permissions": [
        { 
          "role": "anonymous", 
          "actions": [ { "action": "read" } ] 
        }
      ]
    }
  }
}

--template.rest.enabled

Aktivieren oder Deaktivieren von REST-Endpunkten für alle übereinstimmenen Entitäten. Zulässige Werte: true, false. Standardwert: true.

Beispiel

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --template.rest.enabled true \
  --permissions "anonymous:read"

Resultierende Konfiguration

{
  "autoentities": {
    "my-def": {
      "template": {
        "rest": { "enabled": true }
      }
    }
  }
}

--template.graphql.enabled

Aktivieren oder deaktivieren Sie GraphQL für alle übereinstimmenen Entitäten. Zulässige Werte: true, false. Standardwert: true.

Beispiel

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --template.graphql.enabled true \
  --permissions "anonymous:read"

Resultierende Konfiguration

{
  "autoentities": {
    "my-def": {
      "template": {
        "graphql": { "enabled": true }
      }
    }
  }
}

--template.mcp.dml-tool

Aktivieren oder deaktivieren Sie MCP-DML-Tools für alle übereinstimmenen Entitäten. Zulässige Werte: true, false. Standardwert: true.

Beispiel

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --template.mcp.dml-tool true \
  --permissions "anonymous:read"

Resultierende Konfiguration

{
  "autoentities": {
    "my-def": {
      "template": {
        "mcp": { "dml-tools": true }
      }
    }
  }
}

--template.health.enabled

Aktivieren oder Deaktivieren von Integritätsprüfungen für alle übereinstimmenen Entitäten. Zulässige Werte: true, false. Standardwert: true.

Beispiel

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --template.health.enabled true \
  --permissions "anonymous:read"

Resultierende Konfiguration

{
  "autoentities": {
    "my-def": {
      "template": {
        "health": { "enabled": true }
      }
    }
  }
}

--template.cache.enabled

Aktivieren oder Deaktivieren des Antwortzwischenspeicherns für alle übereinstimmenen Entitäten. Zulässige Werte: true, false. Standardwert: false.

Beispiel

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --template.cache.enabled true \
  --permissions "anonymous:read"

Resultierende Konfiguration

{
  "autoentities": {
    "my-def": {
      "template": {
        "cache": { "enabled": true }
      }
    }
  }
}

--template.cache.ttl-seconds

Zwischenspeichern sie in Sekunden für alle übereinstimmenden Entitäten. Standardwert: null.

Beispiel

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --template.cache.enabled true \
  --template.cache.ttl-seconds 30 \
  --permissions "anonymous:read"

Resultierende Konfiguration

{
  "autoentities": {
    "my-def": {
      "template": {
        "cache": { 
          "enabled": true, 
          "ttl-seconds": 30 
        }
      }
    }
  }
}

--template.cache.level

Cacheebene für alle übereinstimmenen Entitäten. Zulässige Werte: L1, L1L2. Standardwert: L1L2.

Beispiel

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --template.cache.enabled true \
  --template.cache.ttl-seconds 30 \
  --template.cache.level L1L2 \
  --permissions "anonymous:read"

Resultierende Konfiguration

{
  "autoentities": {
    "my-def": {
      "template": {
        "cache": { 
            "enabled": true, 
            "ttl-seconds": 30, 
            "level": "l1l2" 
        }
      }
    }
  }
}

Vollständiges Beispiel

dab auto-config my-def \
  --patterns.include "dbo.%" \
  --patterns.exclude "dbo.internal%" \
  --patterns.name "{schema}_{object}" \
  --template.rest.enabled true \
  --template.graphql.enabled true \
  --template.cache.enabled true \
  --template.cache.ttl-seconds 30 \
  --template.cache.level L1L2 \
  --permissions "anonymous:read"

Resultierende Konfiguration

{
  "autoentities": {
    "my-def": {
      "patterns": {
        "include": [ "dbo.%" ],
        "exclude": [ "dbo.internal%" ],
        "name": "{schema}_{object}"
      },
      "template": {
        "rest": { "enabled": true },
        "graphql": { "enabled": true },
        "cache": { 
            "enabled": true, 
            "ttl-seconds": 30, 
            "level": "l1l2" 
        }
      },
      "permissions": [
        { 
          "role": "anonymous", 
          "actions": [ { "action": "read" } ] 
        }
      ]
    }
  }
}