JSON-Konfiguration

Die Optionen und Einstellungen für die Ausführung eines vcdb-tool Befehls können in einer Konfigurationsdatei im JSON-Format definiert werden. Dies stellt eine Alternative zur manuellen Angabe der Optionen über die Kommandozeile dar. Innerhalb der Konfigurationsdatei sind die Optionen in logische Abschnitte organisiert, wobei jeder Befehl je nach Aufgabe und Operation einen oder mehrere dieser Abschnitte verwenden kann.

Das folgende Beispiel zeigt den grundlegenden Aufbau einer Konfigurationsdatei mit den wichtigsten Abschnitten. Eine Konfigurationsdatei kann alle Abschnitte enthalten, um sie für verschiedene Befehle wiederverwenden zu können, oder nur die Abschnitte, die für einen bestimmten Befehl erforderlich sind.

{
  "databaseOptions": {...},
  "importOptions": {...},
  "readOptions": {...},
  "exportOptions": {...},
  "writeOptions": {...},
  "deleteOptions": {...},
  ...
}

Konfigurationsabschnitte

Der Zweck jedes Konfigurationsabschnitts wird nachfolgend erläutert. Inhalt und Verwendung dieser Abschnitte für verschiedene vcdb-tool Befehle werden in den folgenden Kapiteln detaillierter beschrieben.

Abschnitt Beschreibung

"databaseOptions"

Definiert die Verbindungsparameter für eine oder mehrere VCDB-Instanzen. Kann von allen allen Befehlen genutzt werden, die eine Datenbankverbindung benötigen.

"importOptions"

Definiert Optionen zur Steuerung des Importvorgangs.

"readOptions"

Legt Einstellungen für das Einlesen von Eingabedateien fest, einschließlich formatspezifischer Optionen.

"exportOptions"

Definiert Optionen zur Steuerung des Exportvorgangs.

"writeOptions"

Legt Einstellungen für das Schreiben von Ausgabedateien fest, einschließlich formatbezogener Optionen.

"deleteOptions"

Definiert Optionen zur Steuerung des Löschvorgangs.

"reportOptions"

Definiert Optionen für die Erzeugung des Datenbankberichts.

Konfigurationsdateien können über die Option --config-file beim Ausführen von vcdb-tool Befehlen geladen werden.

  • Linux

  • Windows CMD

./vcdb import citygml \
    --config-file=/path/to/my-config.json \
    my-city.gml
vcdb import citygml ^
    --config-file=C:\path\to\my-config.json ^
    my-city.gml

  • Konfigurationsdateien können flexibel zusammen mit Kommandozeilenoptionen verwendet werden. Kommandozeilenoptionen haben jedoch stets Vorrang.

  • Bei einigen Befehle können bestimmte Opionen nur über die JSON-Konfiguration eingestellt werden, aber nicht über die Kommandozeile.

  • Wenn Plugins für vcdb-tool registriert sind, können sie die Konfiguration durch eigene Abschnitte erweitern.