wikibase-cli/bin/wb-sparql.js

A command-line interface to Wikibase

#!/usr/bin/env node
import { readFileSync } from 'node:fs'
import { resolve } from 'node:path'
import { commandWithTemplateCustomHelp } from '#lib/command_with_template_custom_help'
import errors_ from '#lib/errors'
import { executeFunction } from '#lib/execute_function'
import program from '#lib/program'
import { sparqlQueryCommand } from '#lib/sparql_query_command'
import wellknownQueries from '#lib/wellknown_queries'

program.customHelpOption = commandWithTemplateCustomHelp

await program
.option('-r, --raw', 'get raw, non-simplified JSON results')
.option('-d, --dry', 'output the SPARQL without running the query')
.option('-o, --open', 'open the query in the Query Service GUI')
.option('-f, --format <format>', "set output format: json, xml, tsv, csv, binrdf, table. Default: 'table' when 1 value is selected, 'json' otherwise")
.option('-x, --index <variable>', "return the result as an index, instead of a list, using the passed variable as key (can't be used with the 'raw' option)")
.option('--log-response-headers [comma-separated headers names]', 'request to output all or some HTTP header fields from the server response on stderr')
.process('sparql')

const path = program.args[0]

const main = async () => {
  const extension = path.split('.').slice(-1)[0]

  let sparql, absoluePath

  // Allow to pass a JS module that exports a function
  // to which is passed the remaining arguments
  // and from which the SPARQL request is generated
  if (extension.endsWith('js')) {
    absoluePath = resolve(process.cwd(), path)
  // or pass the name of one of the wellknown queries
  } else if (wellknownQueries.list.includes(path)) {
    absoluePath = wellknownQueries.getAbsolutePath(path)
  }

  if (absoluePath != null) {
    const fnArgs = program.args.slice(1)
    sparql = await executeFunction(absoluePath, fnArgs)
  } else {
    sparql = readFileSync(path, { encoding: 'utf-8' })
  }

  if (!sparql.replace('\n', ' ').match(/(SELECT|DESCRIBE|CONSTRUCT|ASK)/i)) {
    errors_.bundle("this doesn't look like SPARQL", { sparql })
  }

  const { index, format } = program

  if (index) {
    const variableMatch = ` ?${index} `
    const selectSection = sparql.split('{')[0]
    // If the variable can't be found in the SPARQL SELECT section
    // we won't be able to index the results using it
    if (!selectSection.match(variableMatch)) {
      errors_.bundle("the index variable can't be found in the SPARQL request", { sparql, index })
    }
  }

  sparqlQueryCommand(sparql, format)
}

if (program.showHelp) {
  await program.customHelpOption()
} else {
  await main().catch(console.error)
}