vcdb-tool

vcdb-tool ist ein Kommandozeilenwerkzeug und der Standard-Client für die VC Database v5. Es unterstützt das Importieren und Exportieren von Stadtmodelldaten sowie Operationen zur Daten- und Datenbankverwaltung. Die Kommandozeilenschnittstelle (CLI) bietet verschiedene Befehle zur Interaktion mit der Datenbank, jeweils mit eigenen Parametern und Optionen. Neben der manuellen Ausführung in einer Shell kann vcdb-tool auch automatisiert, in andere Software integriert und in Workflows und Pipelines verwendet werden.

Hauptmerkmale

  • Unterstützung für CityGML 3.0, 2.0 und 1.0

  • Unterstützung für CityJSON 2.0, 1.1 und 1.0, einschließlich CityJSONSeq

  • On-the-fly Upgrade und Downgrade zwischen Versionen

  • Import und Export von Datensätzen beliebiger Dateigröße

  • Mehrere Importstrategien für konsistente Fortführung

  • Löschung und Terminieren von Stadtobjekten mit Unterstützung für Objekthistorien

  • Erweiterte Abfragefunktionen basierend auf OGC CQL2 und SQL

  • Erweiterbar durch benutzerdefinierte Plugins

  • Verfügbar als Docker-Image

  • Nahtlose Integration in automatisierte Workflows und Prozesse

Installation und Start

vcdb-tool wird als ZIP-Paket bereitgestellt und erfordert keine Installation. Entpacken Sie einfach das Paket in ein Verzeichnis Ihrer Wahl. In diesem Verzeichnis befindet sich das vcdb Startskript, mit dem die Software ausgeführt wird. Es werden zwei Versionen dieses Startskripts mitgeliefert:

  1. vcdb für UNIX/Linux/macOS-Systeme; und

  2. vcdb.bat für Windows-Systeme.

Um vcdb-tool zu starten, öffnen Sie eine Shell, navigieren zum Installationsverzeichnis von vcdb-tool und führen dort den folgenden Befehl aus, um eine allgemeine Hilfeübersicht in der Konsole anzuzeigen. Auf UNIX/Linux-Systemen müssen möglicherweise zunächst die entsprechenden Dateiberechtigungen gesetzt werden, um das Skript ausführbar zu machen.

Java ist erforderlich, um die Software auszuführen. Weitere Informationen finden Sie in den Systemanforderungen.
  • Linux

  • Windows CMD

chmod u+x vcdb
./vcdb --help
vcdb --help    # you can omit the .bat file extension

Wenn Ihr System korrekt eingerichtet ist und der Befehl vcdb --help erfolgreich ausgeführt wird, sollte eine Ausgabe ähnlich dem folgenden Beispiel erscheinen.

image vcdbHelp
Figure 1. Ausführung von vcdb --help in der Windows-Eingabeaufforderung.

Verwendung von Umgebungsvariablen beim Start

vcdb-tool unterstützt die folgenden Umgebungsvariablen zur Konfiguration des Startvorgangs.

Umgebungsvariable Beschreibung

JAVA_HOME

Gibt das Verzeichnis an, in sich die Java Runtime Environment (JRE) oder das Java Development Kit (JDK) auf Ihrem System befindet.

DEFAULT_JVM_OPTS

Definiert Optionen für die Java Virtual Machine (JVM)-Optionen beim Startvorgang.

JAVA_OPTS

Funktioniert wie DEFAULT_JVM_OPTS, hat aber Vorrang.

VCDB_OPTS

Funktioniert wie JAVA_OPTS und DEFAULT_JVM_OPTS, hat aber gegenüber beiden Vorrang.

JAVA_HOME legt fest, welche JRE oder welches JDK von vcdb-tool verwendet werden soll. Das kann hilfreich sein, wenn eine andere Java-Version als die Standardinstallation auf dem System genutzt werden soll oder wenn die Java-Installation nicht automatisch erkannt wird und deshalb vcdb-tool nicht startet.

vcdb-tool wird mit Standard-JVM-Optionen gestartet, die jedoch durch Setzen der Umgebungsvariablen VCDB_OPTS überschrieben werden können. Alternativ können auch JAVA_OPTS oder DEFAULT_JVM_OPTS dazu verwendet werden, JVM-Optionen an das vcdb Skript zu übergeben. Um beispielsweise die maximale Größe des Heap-Space der JVM zu erhöhen, kann die Option -Xmx verwendet werden. Der folgende Befehl zeigt, wie beim Aufruf von vcdb zum einen JAVA_HOME gesetzt wird, um die Java-Installation anzugeben, und zum anderen über VCDB_OPTS zwei Gigabyte für den Heap-Space zugewiesen werden.

  • Linux

  • Windows CMD

export JAVA_HOME="/path/to/your/java/installation"
export VCDB_OPTS="-Xmx2g"

./vcdb import citygml \
    -H localhost -d citydb -u citydb_user -p mySecret \
    /my/city.gml
set JAVA_HOME="C:\path\to\your\java\installation"
set VCDB_OPTS="-Xmx2g"

vcdb import citygml citygml ^
    -H localhost -d citydb -u citydb_user -p mySecret ^
    C:\my\city.gml

Zusätzliche JVM-Optionen wie -Xms für die initiale Größe des Heap-Spaces oder Systemeigenschaften über -Dproperty=value können bei Bedarf ebenfalls hinzugefügt werden.

Die Standard-JVM-Optionenen sind in der Regel für die meisten Anwendungsfälle ausreichend und sollten nur bei Bedarf überschrieben werden. Fortgeschrittene Benutzer können auch das vcdb Startskript direkt anpassen, um die Start-Konfiguration zu ändern und benutzerdefinierte JVM-Optionen hinzuzufügen.