La commande xqueryupdate prend un fichier XQuery en tant que son argument unique et l'exécute avec un fichier d'entrée optionnel pour produire un fichier de sortie mis à jour. Les fichiers d'entrée et de sortie sont spécifiés en tant qu'options.
raptorxmlxbrl xquery [options] XQuery-File |
•L'argument XQuery-File est le chemin et le nom du fichier XQuery à exécuter.
•Vous pouvez utiliser XQuery 1.0 ou 3.0. XQuery 3.0 est utilisé par défaut.
Exemples
Exemples de la commande 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 (and RaptorXMLXBRLServer for administration commands) on Windows raptorxmlxbrl (and raptorxmlxbrlserver for administration commands) on Windows and Unix (Linux, Mac) * Note that lowercase (raptorxmlxbrl and raptorxmlxbrlserver) works on all platforms (Windows, Linux, and Mac), while upper-lower (RaptorXMLXBRL) works only on Windows and Mac. * Use forward slashes on Linux and Mac, backslashes on Windows. |
On Windows systems: When spaces or special characters occur in strings (for example in file or folder names, or company, person or product names), use quotes: for example, "My File". Note, however, that a backslash followed by a double-quotation mark (for example, "C:\My directory\") might not be read correctly. This is because the backslash character is also used to indicate the start of an escape sequence, and the escape sequence \" stands for the double-quotation mark character. If you want to escape this sequence of characters, use a preceding backslash, like this: \\". To summarize: If you need to write a file path that contains spaces or an end backslash, write it like this: "C:\My Directory\\". |
Options
Les options sont recensées dans la forme abrégée (si disponible) et dans la forme longue. Vous pouvez utiliser un ou deux tirets pour les formes abrégées et longues. Une option peut ou ne peut pas prendre une valeur. Si elle prend une valeur, elle est écrite comme ceci : --option=value. Des valeurs peuvent être spécifiées sans guillemets sauf dans deux cas : (i) si le string valeur contient des espace, ou (ii) s'il est explicitement indiqué dans la description que des guillemets sont exigés. Si une option prend une valeur booléenne et qu'aucune valeur n'est spécifiée, alors la valeur par défaut de l'option est TRUE. Utiliser l'option --h, --help pour afficher des informations à propos de la commande.
.
--indent-characters = VALUE Spécifie le string de caractère à utiliser en tant que retrait. |
--input = FILE L'URL du fichier XML à transformer. |
--omit-xml-declaration = true|false Option de sérialisation pour spécifier si la déclaration XML doit être omise de la sortie ou pas. Si true, il n'y aura pas de déclaration XML dans le document de sortie. Si false, une déclaration XML sera incluse. La valeur par défaut est false. Note : les valeurs d'option booléennes sont configurées sur true si l'option est spécifiée sans une valeur. |
output = FILE, xsltoutput = FILE L'URL du fichier sortie-primaire. Par exemple, dans le cas d'une sortie HTML de fichier multiple, le fichier de sortie primaire sera l'emplacement du fichier HTML du point d'entrée. Les fichiers de sortie supplémentaires, comme des fichiers d'image générée, sont rapportés en tant que xslt-additional-output-files. Si aucune option --output ou --xsltoutput n'est spécifiée, la sortie est écrite sur la sortie standard. |
--output-encoding = VALUE La valeur de l'attribut d'encodage dans le document de sortie. Les valeurs valides sont des noms dans le registre d'ensemble de caractères IANA. La valeur par défaut est UTF-8. |
--output-indent = true|false Si true, la sortie sera en retrait conformément à sa structure hiérarchique. Si false, il n'y aura pas de retrait hiérarchique. La valeur par défaut est false. Note : les valeurs d'option booléennes sont configurées sur true si l'option est spécifiée sans une valeur. |
--output-method = xml|html|xhtml|text Spécifie le format de sortie. La valeur par défaut est xml. |
--p | --param = KEY:VALUE Spécifie la valeur d'un paramètre externe. Un paramètre externe est déclaré dans le document XQuery avec la déclaration declare variable suivi par un nom de variable puis le mot-clé external suivi par le point-virgule de fin de ligne. Par exemple : declare variable \$foo as xs:string external; Le mot-clé external, \$foo devient un paramètre externe, dont la valeur est passée pendant le runtime depuis une source externe. Le paramètre externe reçoit une value avec la commande CLI. Par exemple : --param=foo:'MyName' Dans l'instruction de description ci-dessus, KEY est le nom de paramètre externe, VALUE est la valeur du paramètre externe, donné en tant qu'une expression XPath. Les noms de paramètres utilisés sur la CLI doivent être déclarés dans le document XQuery. Si plusieurs paramètres externes sont des valeurs passées sur la CLI, chacun doit être recevoir une option séparée --param. Les doubles guillemets doivent être utilisés si l'expression XPath contient des espaces. |
Spécifie paramètre de feuille de style global. KEY est le nom de paramètre, VALUE est une expression XPath qui fournit la valeur de paramètre. Les noms de paramètre utilisés sur la CLI doivent être déclarés dans la feuille de style. Si plusieurs paramètres multiples sont utilisés, le changement --param doit être utilisé avant chaque paramètre. Les double guillemets doivent être utilisés autour de l'expression XPath si elle contient un espace ; que l'espace se trouve dans l'expression XPath elle-même ou dans un littéral de string dans l'expression. Par exemple : 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 Si true, passe à une version antérieure d'avertissements de tous les types d'erreurs qui sont détectés dans le contexte statique XPath. Alors qu'une erreur entraînerait l'échec de l'exécution, un avertissement permettrait la poursuite du traitement. Le défaut est false. |
--xquery-version = 1|1.0|3|3.0|3.1 Spécifie si le processeur XQuery devrait utiliser XSLT XQuery 1.0 ou XQuery 3.0. La valeur par défaut est 3.1. |
|
--load-xml-with-psvi = true|false Active la validation des fichiers XML d'entrée et génère des informations de post-schema-validation pour les fichiers. La valeur par défaut est : true. |
--schema-imports = load-by-schemalocation | load-preferring-schemalocation | load-by-namespace | load-combining-both | license-namespace-only Spécifie le comportement des éléments xs:import, chacun d'entre eux ayant un attribut namespace optionnel et un attribut schemaLocation optionnel : <import namespace="someNS" schemaLocation="someURL">. L'option spécifie s'il faut charger un document de schéma ou juste mettre un espace de noms sous licence, et, si un document de schéma doit être chargé, quelle information doit être utilisée pour le trouver. Défaut : load-preferring-schemalocation. Le comportement est le suivant : •load-by-schemalocation: La valeur de l'attribut schemaLocation est utilisée pour situer le schéma, en prenant en compte les mappages de catalogue. Si l'attribut de l'espace de nom est présent, l'espace de noms est importé (licencé). •load-preferring-schemalocation: Si l'attribut schemaLocation est présent, il est utilisé en prenant en compte les mappages de catalogue. Si l'attribut schemaLocation est présent, la valeur de l'attribut namespace est utilisée via un mappage de catalogue. C'est la valeur par défaut. •load-by-namespace: La valeur de l'attribut namespace est utilisée pour situer le schéma via un mappage de catalogue. •load-combining-both: Si soit l'Attribut namespace ou l'attribut schemaLocation a un mappage de catalogue, le mappage est utilisé. Si les deux ont des mappages de catalogue, alors la valeur de l'option --schema-mapping (option XBRL et option XML/XSD) décide de quel mappage utiliser. Si aucun mappage de catalogue n'est présent, l'attribut schemaLocation est utilisé. •license-namespace-only: Le nom d'espace est importé. Aucun document de schéma n'est importé. |
--schemalocation-hints = load-by-schemalocation | load-by-namespace | load-combining-both | ignore Spécifie le comportement des attributs xsi:schemaLocation et xsi:noNamespaceSchemaLocation : S'il faut charger un document de schéma et, si oui, quelle information doit être utilisée pour la trouver. Défaut : load-by-schemalocation. •La valeur load-by-schemalocation utilise l'URL de l'emplacement de schéma dans les attributs xsi:schemaLocation et xsi:noNamespaceSchemaLocation dans les documents d'instance XML ou XBRL. Il s'agit de la valeur par défaut. •La valeur load-by-namespace prend la part d'espace de nom xsi:schemaLocation et un string vide dans le cas de xsi:noNamespaceSchemaLocation et localise le schéma par le biais d'un mappage de catalogue. •Si load-combining-both est utilisé et si soit la partie espace de noms ou la partie URL a un mappage de catalogue, alors le mappage de catalogue est utilisé. Si tous deux ont des mappages de catalogue, alors la valeur de l'option de --schema-mapping (option XBRL et option XML/XSD) de quel mappage utiliser. Si ni l'espace de noms ni l'URL n'a un mappage de catalogue, l'URL est utilisée. •Si la valeur de l'option est ignore, les attributs xsi:schemaLocation et xsi:noNamespaceSchemaLocation seront ignorés tous les deux. |
--schema-mapping = prefer-schemalocation | prefer-namespace Si l'emplacement de schéma et l'espace de noms sont tous les deux utilisés pour trouver un document de schéma, spécifie lequel des deux doit être utilisé pendant la consultation du catalogue. (Si soit l'option --schemalocation-hints ou l'option --schema-imports a une valeur de load-combining-both, et si les parties d'espace de noms et d'URL impliquées ont toutes les deux des mappages de catalogue, alors la valeur de cette option spécifie lequel des deux mappages utiliser (mappage d'espace de noms ou mappage URL ; la valeur prefer-schemalocation réfère au mappage URL).) Défaut : prefer-schemalocation. |
--xinclude = true|false Active la prise en charge de XML Inclusions (XInclude). La valeur par défaut est false. Si false, les élément include d'XInclude sont ignorés. Note : les valeurs d'option booléennes sont configurées sur true si l'option est spécifiée sans une valeur. |
--xml-mode = wf|id|valid Spécifie le mode de traitement XML à utiliser pour le document d'instance XML : wf=wellformed check (vérification de la bonne forme); id=bien formé avec des contrôles ID/IDREF ; valid=validation. La valeur par défaut est wf. Veuillez noter qu'une valeur de valid exige que chaque document d'instance chargé depuis les traitements référence un DTD. Si aucun DTD n'existe, une erreur est rapportée. |
--xml-mode-for-schemas = wf|id|valid Spécifie le mode de traitement XML à utiliser pour les documents de schéma XML : wf=vérification de la bonne formation ; id=contrôles de la bonne formation avec ID/IDREF ; valid=validation. La valeur par défaut est wf. Veuillez noter qu'une valeur de valid exige que chaque document de schéma chargé pendant le traitement référence un DTD. Si aucun DTD n'existe, une erreur est rapportée. |
--xml-validation-error-as-warning = true|false Si true, traite les erreurs de validation en tant qu'avertissements. Si les erreurs sont traitées en tant qu'avertissements, les traitements supplémentaires, comme des transformations XSLT, continueront quelles que soient les erreurs. La valeur par défaut est false. |
--xpath-static-type-errors-as-warnings = true|false Si true, passe à une version antérieure d'avertissements de tous les types d'erreurs qui sont détectés dans le contexte statique XPath. Alors qu'une erreur entraînerait l'échec de l'exécution, un avertissement permettrait la poursuite du traitement. Le défaut est false. |
--xsd = FILE Spécifie un ou plusieurs documents de Schéma XML à utiliser pour la validation des documents d'instance XML. Ajouter l'option plusieurs fois pour spécifier plus d'un document de schéma. |
--xsd-version = 1.0|1.1|detect Spécifie la version du langage de définition de Schéma W3C (XSD) à utiliser. Le défaut est 1.0. Cette option peut être utile pour découvrir comment un schéma compatible à 1.0 n'est pas compatible à 1.1. L'option detect est une fonction spécifique à Altova. Elle permet la détection de la version du document de Schéma XML (1.0 ou 1.1) en lisant la valeur de l'attribut vc:minVersion de l'élément du document <xs:schema>. Si la valeur de l'attribut @vc:minVersion est 1.1, le schéma est détecté comme étant de version 1.1. Pour toute autre valeur, ou si l'attribut @vc:minVersion est absent, le schéma est détecté comme étant de version 1.0. |
|
--catalog = FILE Spécifie le chemin absolu vers un fichier de catalogue root qui n'est pas le fichier catalogue root installé. La valeur par défaut est le chemin absolu vers le fichier de catalogue root installé (<installation-folder>\Altova\RaptorXMLXBRLServer2024\etc\RootCatalog.xml). Voir la section, Catalogues XML, pour plus d'informations à propos du travail avec les catalogues. |
--user-catalog = FILE Spécifie le chemin absolu vers un catalogue XML à utiliser en plus du catalogue root. Voir la section, Catalogues XML, pour plus d'informations concernant le travail avec des catalogues. |
--enable-globalresources = true|false Active les ressources globales. La valeur par défaut est false. Note : les valeurs d'option booléennes sont configurées sur true si l'option est spécifiée sans une valeur. |
|
Ces options définissent la gestion des fonctions d'extension spéciales disponibles dans un certain nombre de produits Altova de niveau d'entreprise (comme XMLSpy Enterprise Edition). Leur utilisation est décrite dans les manuels d'utilisateur de ces produits. --chartext-disable = true|false Désactive les extensions de graphique. La valeur par défaut est false. Note : les valeurs d'option booléennes sont configurées sur true si l'option est spécifiée sans une valeur. |
--dotnetext-disable = true|false Désactive les extensions .NET. La valeur par défaut est false. Note : les valeurs d'option booléennes sont configurées sur true si l'option est spécifiée sans une valeur. |
--jvm-location = FILE FILE spécifie l'emplacement de la Java Virtual Machine (DLL sur Windows, objet partagé sur Linux). La JVM est nécessaire si vous utilisez les fonctions d'extension Java dans votre code XSLT/XQuery. La valeur par défaut est false. |
--javaext-barcode-location = FILE Spécifie le chemin vers le dossier qui contient le fichier d'extension du code-barres AltovaBarcodeExtension.jar. Le chemin doit être donné dans une des formes suivantes : •Un URI de fichier, par exemple : --javaext-barcode-location="file:///C:/Program Files/Altova/RaptorXMLXBRLServer2024/etc/jar/" •Un chemin Windows avec un échappement par barres obliques inversées, par exemple : --javaext-barcode-location="C:\\Program Files\\Altova\\RaptorXMLXBRLServer2024\\etc\\jar\\" |
--javaext-disable = true|false Désactive les extensions Java. La valeur par défaut est false. Note : les valeurs d'option booléennes sont configurées sur true si l'option est spécifiée sans une valeur. |
|
--error-format = text|shortxml|longxml Spécifie le format de la sortie d'erreur. La valeur par défaut est text. Les autres options génèrent des formats XML, avec longxml générant plus de détails. |
--error-limit = N | unlimited Spécifie la limite d'erreur avec une plage de valeur de 1 à 999 ou unlimited. La valeur par défaut est 100. Le traitement s'arrête lorsque la limite d'erreur est atteinte. Utile pour limiter l'utilisation du processeur pendant la validation/transformation. |
--info-limit = N | unlimited Spécifie la limite de message d'information dans la plage 1-65535 ou unlimited. Le traitement continue si la limite d'info spécifiée est atteinte, mais les messages ultérieurs ne sont pas rapportés. La valeur par défaut est 100. |
--help Affiche le texte d'aide pour la commande. Par exemple, valany --h. (en alternative, la commande help peut être utilisée avec un argument. Par exemple : help valany.) |
--log-output = FILE Écrit la sortie de log dans l'URL de fichier spécifié. Veuillez vous assurer que la CLI a une permission d'écriture dans l'emplacement de la sortie. |
--network-timeout = VALEUR Spécifie le timeout en secondes pour les opérations I/O à distance. La valeur par défaut est : 40000. |
--verbose = true|false Une valeur de true permet la sortie d'informations supplémentaires pendant la validation. La valeur par défaut est false. Note : les valeurs d'option booléennes sont configurées sur true si l'option est spécifiée sans une valeur. |
--verbose-output = FILE Écrit la sortie verbeuse sur FILE. |
--version Affiche la version de RaptorXML+XBRL Server. Si utilisé avec une commande, placer --version avant la commande. |
--warning-limit = N | unlimited Spécifie la limite d'avertissement dans la plage 1-65535 ou unlimited. Le traitement se poursuit si cette limite a été atteinte, mais d'autres avertissements ne sont pas rapportés. La valeur par défaut est 100. |
|
