Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

improve arq command line documentation #2411

Open
9 tasks
VladimirAlexiev opened this issue Apr 11, 2024 · 0 comments
Open
9 tasks

improve arq command line documentation #2411

VladimirAlexiev opened this issue Apr 11, 2024 · 0 comments
Labels
enhancement Incrementally add new feature

Comments

@VladimirAlexiev
Copy link

VladimirAlexiev commented Apr 11, 2024

Version

4.5.0

Feature

arq --help prints this:

arq --data=<file> --query=<query>
  Control
      --explain              Explain and log query execution
      --repeat=N or N,M      Do N times or N warmup and then M times (use for timing to overcome start up costs of Java)
      --optimize=            Turn the query optimizer on or off (default: on)
  Time
      --time                 Time the operation
  Query Engine
      --engine=EngineName    Register another engine factory[ref]
      --unengine=EngineName   Unregister an engine factory
  Dataset
      --data=FILE            Data for the dataset - triple or quad formats
      --graph=FILE           Graph for default graph of the datset
      --namedGraph=FILE      Add a graph into the dataset as a named graph
  Results
      --results=             Results format (Result set: text, XML, JSON, CSV, TSV; Graph: RDF serialization)
      --desc=                Assembler description file
  Query
      --query, --file        File containing a query
      --syntax, --in         Syntax of the query
      --base                 Base URI for the query
  Symbol definition
      --set                  Set a configuration symbol to a value
  General
      -v   --verbose         Verbose
      -q   --quiet           Run with minimal output
      --debug                Output information for debugging
      --help
      --version              Version information
      --strict               Operate in strict SPARQL mode (no extensions of any kind)

I have the following questions and improvement suggestions:

  • clarify that --data can be used multiple times, and whether the other Dataset options can
  • clarify whether FILE can be a URL (http, https)
  • fix spelling of datset in --graph
  • if the FILE in --graph and --namedGraph is in quad format, is the graph part of FILE removed?
  • if the FILE in --graph is in triple format, what is the difference from --data?
  • if the FILE in --namedGraph is in triple format, is the name/URL of FILE used as the graph name?
  • move --desc to the Dataset section because it concerns input
  • describe --desc better

https://jena.apache.org/documentation/query/cmds.html#arqquery is much poorer

  • it should be brought in line with the command line help.

Are you interested in contributing a solution yourself?

None

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Incrementally add new feature
Projects
None yet
Development

No branches or pull requests

1 participant