Der Befehl xquery erhält als einziges Argument eine XQuery-Datei und führt diese mit einer optionalen Input-Datei aus, um eine Ausgabedatei zu erzeugen. Die Input-Datei und die Ausgabedatei sind als Optionen definiert.
raptorxmlxbrl xquery [options] XQuery-File |
•Das Argument XQuery-File ist der Pfad und Name der auszuführenden XQuery-Datei.
•Sie können XQuery 1.0 oder 3.0 verwenden. Standardmäßig wird XQuery 3.0 verwendet.
Beispiele
Beispiele für den Befehl xquery:
•raptorxmlxbrl xquery --output=c:\Output.xml c:\TestQuery.xq
•raptorxmlxbrl xquery --input=c:\Input.xml --output=c:\Output.xml --param=company:"Altova" --p=date:"2006-01-01" c:\TestQuery.xq
•raptorxmlxbrl xquery --input=c:\Input.xml --output=c:\Output.xml --param=source:" doc( 'c:\test\books.xml' )//book "
•raptorxmlxbrl xquery --output=c:\Output.xml --omit-xml-declaration=false --output-encoding=ASCII c:\TestQuery.xq
RaptorXMLXBRL (und RaptorXMLXBRLServer für Administrator-Befehle) unter Windows raptorxmlxbrl und raptorxmlxbrlserver für Administrator-Befehle) unter Windows und Unix (Linux, Mac) * Beachten Sie, dass klein geschriebene Befehle (raptorxmlxbrl und raptorxmlxbrlserver) auf allen Plattformen (Windows, Linux und Mac) funktionieren, während großgeschriebene Befehle (RaptorXMLXBRL) nur unter Windows und Mac ausgeführt werden. *Verwenden Sie auf Linux und Mac-Systemen Schrägstriche und auf Windows-Systemen umgekehrte Schrägstriche. |
Auf Windows-Systemen: Verwenden Sie bei Vorhandensein von Leerzeichen oder Sonerzeichen in Strings (z.B. in Datei- oder Ordnernamen oder Firmen-, Personen- oder Produktnamen) Anführungszeichen: z.B., "Meine Datei". Beachten Sie jedoch, dass ein von einem doppelten Anführungszeichen gefolgter umgekehrter Schrägstrich (z.B: "C:\Mein Verzeichnis\") eventuell nicht korrekt gelesen wird, da der umgekehrte Schrägstrich auch den Beginn einer Escape-Sequenz markiert und die Escape-Sequenz \" für ein doppeltes Anführungszeichen steht. Wenn Sie diese Zeichensequenz mit einem Escape versehen wollen, verwenden Sie einen vorangestellten umgekehrten Schrägstrich, wie den folgenden: \\". Einfacher ausgedrückt: Wenn Sie einen Dateipfad, der Leerzeichen oder einen umgekehrten Schrägstrich am Ende enthält, schreiben müssen, so schreiben Sie diesen folgendermaßen: "C:\Mein Verzeichnis\\". |
Optionen
Optionen werden in ihrer kurzen Form (falls verfügbar) und in ihrer langen Form aufgelistet. Für die kurze und die lange Form können ein oder zwei Bindestriche verwendet werden. Eine Option kann, muss aber keinen Wert erhalten. Eine Option, die einen Wert erhält, wird folgendermaßen geschrieben: --option=wert. Werte können außer in zwei Fällen ohne Anführungszeichen definiert werden: (i) wenn der Wertestring Leerzeichen enthält oder (ii) wenn in der Beschreibung der Option explizit erwähnt ist, dass Anführungszeichen zwingend erforderlich sind. Wenn eine Option einen Booleschen Wert erhält und kein Wert definiert ist, so ist der Standardwert der Option TRUE. Mit Hilfe der Option --h, --help können Sie Informationen über den Befehl anzeigen.
--indent-characters = VALUE Definiert den Zeichenstring, der als Einrückung verwendet werden soll. |
--input = FILE Die URL der zu transformierenden XML-Datei. |
--omit-xml-declaration = true|false Serialisierungsoption, mit der angegeben wird, ob die XML-Deklaration in der Ausgabe enthalten sein soll oder nicht. Wenn der Wert true ist, enthält das Ausgabedokument keine XML-Deklaration. Wenn der Wert false ist, wird eine XML-Deklaration inkludiert. Der Standardwert ist false. Hinweis: Die Booleschen Optionswerte werden auf true gesetzt, wenn die Option ohne einen Wert definiert wird. |
output = FILE, xsltoutput = FILE Die URL der primären Ausgabedatei. So ist z.B. im Fall der Ausgabe mehrerer HTML-Dateien die primäre Ausgabedatei der Pfad der Eintrittspunkt-HTML-Datei. Zusätzliche Ausgabedateien wie z.B. generierte Bilddateien werden als xslt-additional-output-files angegeben. Wenn keine --output oder --xsltoutput Option definiert ist, wird die Ausgabe in die Standardausgabe geschrieben. |
--output-encoding = VALUE Der Wert des Kodierungsattributs im Ausgabedokument. Gültige Werte sind die Namen im IANA-Zeichensatz-Register. Der Standardwert ist UTF-8. |
--output-indent = true|false Wenn der Wert true ist, wird die Ausgabe entsprechend ihrer hierarchischen Struktur eingerückt. Bei false gibt es keine hierarchische Einrückung. Der Standardwert ist false. Hinweis: Die Booleschen Optionswerte werden auf true gesetzt, wenn die Option ohne einen Wert definiert wird. |
--output-method = xml|html|xhtml|text Definiert das Ausgabeformat. Der Standardwert ist xml. |
--p | --param = KEY:VALUE Definiert den Wert eines externen Parameters. Ein externer Parameter ist im XQuery-Dokument mit der declare variable Deklaration gefolgt von einem Variablennamen und anschließend dem Schlüsselwort external, gefolgt von einem Semikolon deklariert. Beispiel: declare variable $foo as xs:string external; Aufgrund des Schlüsselworts external wird $foo zu einem externen Parameter, dessen Wert zur Laufzeit von einer externen Quelle aus übergeben wird. Der externe Parameter erhält mit dem CLI-Befehl einen Wert. Beispiel: --param=foo:'MyName' In der obigen Beschreibungsanweisung ist KEY der Name des externen Parameters, VALUE der als XPath-Ausdruck angegebene Wert des externen Parameters. Im CLI verwendete Parameter müssen im XQuery-Dokument deklariert sein. Wenn mehrere externe Parameter als Werte an das CLI übergeben werden, muss jeder eine separate --param Option erhalten. Wenn der XPath-Ausdruck Leerzeichen enthält, muss er in doppelte Anführungszeichen gesetzt werden. |
Definiert einen globalen Stylesheet-Parameter. KEY ist der Parametername, VALUE der als XPath-Ausdruck angegebene Parameterwert. Im CLI verwendete Parameter müssen im Stylesheet deklariert sein. Wenn mehrere Parameter verwendet werden, muss vor jedem Parameter die --param Option verwendet werden. Wenn der XPath-Ausdruck Leerzeichen enthält - ob im XPath-Ausdruck selbst oder in einem String-Literal im Ausdruck - muss er in doppelte Anführungszeichen gesetzt werden. Beispiel: raptorxmlxbrl xslt --input=c:\Test.xml --output=c:\Output.xml --param=date://node[1]/@att1 --p=title:'stringwithoutspace' --param=title:"'string with spaces'" --p=amount:456 c:\Test.xslt |
|
--xpath-static-type-errors-as-warnings = true|false Bei true werden alle im statischen XPath-Kontext gefundenen Typ-Fehler auf eine Warnung herabgestuft. Während die Ausführung bei einem Fehler fehlschlagen würde, könnte sie bei einer Warnung fortgesetzt werden. Die Standardeinstellung ist false. |
--xquery-version = 1|1.0|3|3.0|3.1 Gibt an, ob der XQuery-Prozessor XQuery 1.0 oder XQuery 3.0 verwenden soll. Der Standardwert ist 3.1. |
|
--load-xml-with-psvi = true|false Ermöglicht die Validierung von XML-Input-Dateien und die Generierung von Informationen für diese Dateien nach Validierung des Schemas. Der Standardwert ist: true. |
--schema-imports = load-by-schemalocation | load-preferring-schemalocation | load-by-namespace | load-combining-both | license-namespace-only Definiert das Verhalten von xs:import Elementen, von denen jedes ein optionales namespace Attribut und ein optionales schemaLocation Attribut hat: <import namespace="someNS" schemaLocation="someURL">. Mit der Option wird definiert, ob ein Schema-Dokument geladen oder nur ein Namespace lizenziert werden soll und, wenn ein Schema-Dokument geladen werden soll, anhand welcher Informationen es gesucht werden soll. Standardeinstellung: load-preferring-schemalocation. Das Verhalten ist das folgende: •load-by-schemalocation: Anhand des Werts des schemaLocation Attributs wird der Schemapfad ermittelt, wobei Katalog-Mappings berücksichtigt werden. Wenn das Namespace-Attribut vorhanden ist, wird der Namespace importiert (lizenziert). •load-preferring-schemalocation: Wenn das schemaLocation Attribut vorhanden ist, wird es verwendet, wobei Katalog-Mappings berücksichtigt werden. Falls kein schemaLocation Attribut vorhanden ist, wird der Wert des namespace Attributs über ein Katalog-Mapping verwendet. Dies ist der Standardwert. •load-by-namespace: Anhand des Werts des namespace Attributs wird der Schemapfad über ein Katalog-Mapping ermittelt. •load-combining-both: Wenn entweder das Attribut namespace oder das Attribut schemaLocation ein Katalog-Mapping hat, so wird das Mapping verwendet. Wenn beide Attribute Katalog-Mappings haben, ist es vom Wert der Option --schema-mapping (XBRL-Option und XML/XSD-Option) abhängig, welches Mapping verwendet wird. Falls kein Katalog-Mapping vorhanden ist, wird das schemaLocation Attribut verwendet. •license-namespace-only: Der Namespace wird importiert. Kein Schema-Dokument wird importiert. |
--schema-location-hints = load-by-schemalocation | load-by-namespace | load-combining-both | ignore Definiert das Verhalten der Attribute xsi:schemaLocation und xsi:noNamespaceSchemaLocation: Legt fest, ob ein Schema-Dokument geladen werden soll und falls ja, anhand welcher Informationen es gesucht werden soll. Standardeinstellung: load-by-schemalocation. •Der Wert load-by-schemalocation verwendet die URL des Schemapfads in den Attributen xsi:schemaLocation und xsi:noNamespaceSchemaLocation in XML- oder XBRL-Instanzdokumenten. Dies ist der Standardwert. •Der Wert load-by-namespace verwendet den Namespace-Teil von xsi:schemaLocation und - im Fall von xsi:noNamespaceSchemaLocation - einen leeren String und ermittelt das Schema über ein Katalog-Mapping. •Bei Verwendung von load-combining-both und wenn entweder der Namespace-Teil oder der URL-Teil ein Katalog-Mapping hat, so wird das Katalog-Mapping verwendet. Wenn beide Katalog-Mappings haben, ist es vom Wert der --schema-mapping Option (XBRL-Option und XML/XSD-Option) abhängig, welches Mapping verwendet wird. Wenn weder der Namespace noch die URL ein Katalog-Mapping hat, wird die URL verwendet. •Wenn der Wert der Option ignore ist, werden die beiden Attribute xsi:schemaLocation und xsi:noNamespaceSchemaLocation ignoriert. |
--schema-mapping = prefer-schemalocation | prefer-namespace Wenn ein Schema-Dokument sowohl anhand des Schema-Pfads als auch des Namespace gesucht werden soll, wird damit festgelegt, welche der beiden Optionen beim Katalog-Lookup Vorrang erhält. (Wenn eine der Optionen --schemalocation-hints oder --schema-imports einen Wert load-combining-both hat und wenn die betroffenen Namespace- und URL-Teile beide Katalog-Mappings haben, gibt der Wert dieser Option an, welches der beiden Mappings verwendet werden soll (das Namespace Mapping oder das URL-Mapping; der Wert prefer-schemalocation bezieht sich auf das URL-Mapping)). Der Standardwert ist prefer-schemalocation. |
--xinclude = true|false Aktiviert die Unterstützung für XML-Inkludierungen (XInclude). Der Standardwert ist false. Bei false werden die include-Elemente von XInclude ignoriert. Hinweis: Die Booleschen Optionswerte werden auf true gesetzt, wenn die Option ohne einen Wert definiert wird. |
--xml-mode = wf|id|valid Definiert, welcher XML-Verarbeitungsmodus für das XML-Instanzdokument verwendet werden soll: wf=Wohlgeformtheitsprüfung; id=Wohlgeformtheitsprüfung mit ID/IDREF-Prüfung; valid=Validierung. Der Standardwert ist wf. Beachten Sie, dass jedes bei der Verarbeitung geladene Instanzdokument eine DTD referenzieren muss, damit der Wert valid ausgegeben werden kann. Falls keine DTD vorhanden ist, wird ein Fehler ausgegeben. |
--xml-mode-for-schemas = wf|id|valid Definiert, welcher XML-Verarbeitungsmodus für XML-Schema-Dokumente verwendet werden soll: wf=Wohlgeformtheitsprüfung; id=Wohlgeformtheitsprüfung mit ID/IDREF-Prüfung; valid=Validierung. Der Standardwert ist wf. Beachten Sie, dass jedes bei der Verarbeitung geladene Schema-Dokument eine DTD referenzieren muss, damit der Wert valid ausgegeben werden kann. Falls keine DTD vorhanden ist, wird ein Fehler ausgegeben. |
--xml-validation-error-as-warning = true|false Bei true werden Validierungsfehler als Warnungen behandelt. Wenn Fehler als Warnungen behandelt werden, wird die weitere Verarbeitung, z.B. eine XSLT-Transformation ungeachtet der Fehler fortgesetzt. Die Standardeinstellung ist false. |
--xpath-static-type-errors-as-warnings = true|false Bei true werden alle im statischen XPath-Kontext gefundenen Typ-Fehler auf eine Warnung herabgestuft. Während die Ausführung bei einem Fehler fehlschlagen würde, könnte sie bei einer Warnung fortgesetzt werden. Die Standardeinstellung ist false. |
--xsd = FILE Definiert ein oder mehrere XML-Schema-Dokumente, die für die Validierung von XML-Instanzdokumenten verwendet werden sollen. Um mehr als ein Schema-Dokument zu definieren, fügen Sie die Option mehrmals hinzu. |
--xsd-version = 1.0|1.1|detect Definiert die zu verwendende W3C Schema Definition Language (XSD) Version. Der Standardwert ist 1.0. Diese Option eignet sich auch, um herauszufinden, inwiefern ein 1.0-kompatibles Schema nicht mit Schemaversion 1.1 kompatibel ist. Die Option detect ist eine Altova-spezifische Funktionalität. Mit dieser Option kann die Version des XML-Schema-Dokuments (1.0 oder 1.1) durch Lesen des Werts des vc:minVersion Attributs des <xs:schema> Elements des Dokuments ermittelt werden. Wenn der Wert des @vc:minVersion Attributs 1.1 ist, wird das Schema als Version 1.1 erkannt. Bei jedem anderen Wert wird das Schema als 1.0 erkannt. Bei jedem anderen Wert oder bei Fehlen des @vc:minVersion Attributs wird das Schema als Version 1.0 gelesen. |
|
--catalog = FILE Gibt den absoluten Pfad zu einer Root-Katalog-Datei an, die nicht die installierte Root-Katalog-Datei ist. Der Standardwert ist der absolute Pfad zur installierten Root-Katalog-Datei. (<installationsordner>\Altova\RaptorXMLXBRLServer2024\etc\RootCatalog.xml). Informationen zum Arbeiten mit Katalogen finden Sie im Abschnitt XML-Kataloge. |
--user-catalog = FILE Definiert den absoluten Pfad zu einem XML-Katalog, der zusätzlich zum Root-Katalog verwendet werden soll. Informationen zum Arbeiten mit Katalogen finden Sie im Abschnitt XML-Kataloge. |
--enable-globalresources = true|false Aktiviert die globalen Ressourcen. Standardwert ist false. Hinweis: Die Booleschen Optionswerte werden auf true gesetzt, wenn die Option ohne einen Wert definiert wird. |
|
Diese Optionen definieren die Behandlung von speziellen Erweiterungsfunktionen, die in einer Reihe von Enterprise Versionen von Altova-Produkten (wie z.B. in XMLSpy Enterprise Edition) verfügbar sind. Die Verwendung dieser Funktionen ist im Benutzerhandbuch des jeweiligen Produkts beschrieben. --chartext-disable = true|false Deaktiviert Diagrammerweiterungen. Der Standardwert ist false. Hinweis: Die Booleschen Optionswerte werden auf true gesetzt, wenn die Option ohne einen Wert definiert wird. |
--dotnetext-disable = true|false Deaktiviert .NET-Erweiterungen. Der Standardwert ist false. Hinweis: Die Booleschen Optionswerte werden auf true gesetzt, wenn die Option ohne einen Wert definiert wird. |
--jvm-location = FILE FILE definiert den Pfad zur Java Virtual Machine (DLL unter Windows, freigegebenes Objekt unter Linux). Sie benötigen JVM, wenn Sie Java-Erweiterungsfunktionen in Ihrem XSLT/XQuery-Code verwenden. Die Standardeinstellung ist false. |
--javaext-barcode-location = FILE Definiert den Pfad zum Ordner, der die Barcode-Erweiterungsdatei AltovaBarcodeExtension.jar enthält. Der Pfad muss in einer der folgenden Formen angegeben werden: •als Datei-URI, z.B.: --javaext-barcode-location="file:///C:/Program Files/Altova/RaptorXMLXBRLServer2024/etc/jar/" •als Windows-Pfad mit maskierten umgekehrten Schrägstrichen, z.B.: --javaext-barcode-location="C:\\Program Files\\Altova\\RaptorXMLXBRLServer2024\\etc\\jar\\" |
--javaext-disable = true|false Deaktiviert Java-Erweiterungen. Der Standardwert ist false. Hinweis: Die Booleschen Optionswerte werden auf true gesetzt, wenn die Option ohne einen Wert definiert wird. |
|
--error-format = text|shortxml|longxml Definiert das Format der Fehlerausgabe. Der Standardwert ist text. Mit den anderen Optionen werden XML-Formate generiert, wobei mit longxml mehr Details generiert werden. |
--error-limit = N | unlimited Definiert das Fehlerlimit mit einem Wertebereich von 1 bis 9999 oder unbegrenzt. Der Standardwert ist 100. Bei Erreichung des Fehlerlimits wird die Validierung gestoppt. Dient dazu, die Prozessorverwendung während der Validierung/Transformation einzuschränken. |
--info-limit = N | unlimited Definiert die Grenze für Informationsmeldungen im Bereich von 1-65535 oder als unlimited (unbegrenzt). Die Verarbeitung wird auch nach Erreichen des Info-Limits fortgesetzt, doch werden weitere Meldungen nicht mehr ausgegeben. Der Standardwert ist 100. |
--help Zeigt den Hilfetext zum Befehl an. Beispiel: valany --h. (Alternativ dazu kann der Befehl help zusammen mit einem Argument verwendet werden. Beispiel: help valany.) |
--listfile = true|false Bei true wird das Argument InputFile des Befehls als Textdatei behandelt, die einen Dateinamen pro Zeile enthält. Der Standardwert ist false. (Als Alternative können die Dateien im CLI getrennt durch ein Leerzeichen aufgelistet werden. Beachten Sie allerdings, dass CLIs eine maximale Zeichenanzahl haben.) Beachten Sie, dass die Option --listfile nur auf Argumente, nicht aber auf Optionen angewendet wird. Hinweis: Die Booleschen Optionswerte werden auf true gesetzt, wenn die Option ohne einen Wert definiert wird. |
--log-output = FILE Schreibt die Meldungsausgabe in die angegebene URL. Stellen Sie sicher, dass das CLI Schreibrechte für den Ausgabepfad hat. |
--network-timeout = VALUE Definiert das Timeout für entfernte I/O-Operationen in Millisekunden. Der Standardwert ist: 40000. |
--recurse = true|false Dient zur Auswahl von Dateien innerhalb von Unterverzeichnissen einschließlich ZIP-Archiven. Bei true wählt das Argument InputFile des Befehls die angegebene Datei auch in den Unterverzeichnissen aus. Beispiel: "test.zip|zip\test.xml" wählt Dateien mit dem Namen test.xml auf allen Ordnerebenen des ZIP-Ordners aus. Referenzen auf ZIP-Dateien müssen in Anführungszeichen angegeben werden. Es können die Platzhalter * und ? verwendet werden. Mit *.xml werden folglich alle .xml Dateien im (ZIP-)Ordner ausgewählt. Der Standardwert der Option ist false. Hinweis: Die Booleschen Optionswerte werden auf true gesetzt, wenn die Option ohne einen Wert definiert wird. |
--verbose = true|false Mit dem Wert true wird die Ausgabe zusätzlicher Informationen bei der Validierung aktiviert. Der Standardwert ist false. Hinweis: Die Booleschen Optionswerte werden auf true gesetzt, wenn die Option ohne einen Wert definiert wird. |
--verbose-output = FILE Schreibt die ausführliche Ausgabe in FILE. |
--version Zeigt die Version von RaptorXML+XBRL Server an. Setzen Sie --version bei Verwendung mit einem Befehl vor den Befehl. |
--warning-limit = N | unlimited Definiert das Warnungslimit im Bereich von 1-65535 oder unbegrenzt. Bei Erreichen dieses Limits wird die Verarbeitung fortgesetzt, doch werden keine weiteren Warnungen mehr ausgegeben. Der Standardwert ist 100. |
|
