dba/config  library module
P

Summary

DBA configuration.
Authors
  • Christian Grün, BaseX Team 2005-23, BSD License
Related documents
ViewDescriptionFormat
xqdocxqDoc xml file from the source modulexml
xqparsexqparse xml file from the source modulexml

Imports

This module is imported by 16 modules. It imports 1 modules.

dba/files 2 3 4 5 6 7 8
dba/files 2 3 4 5 6 7 8
dba/files 2 3 4 5 6 7 8
dba/files 2 3 4 5 6 7 8
dba/files 2 3 4 5 6 7 8
dba/files 2 3 4 5 6 7 8
dba/files 2 3 4 5 6 7 8
dba/users 2 3 4 5 6 7
imports
dba/config
imports

Variables

3.1 $config:DIRECTORY

Summary
Current directory.
Type
Annotations (1)
%private()
Source ( 1 lines)
variable $config:DIRECTORY := 'dba-directory'

3.2 $config:QUERY

Summary
Current query.
Type
Annotations (1)
%private()
Source ( 1 lines)
variable $config:QUERY := 'dba-query'

3.3 $config:SESSION-KEY

Summary
Session key.
Type
Source ( 1 lines)
variable $config:SESSION-KEY := 'dba'

Functions

4.1 config:directory

Arities: #0#1

Summary
Returns the current working directory.
Signatures
config:directory ( ) as xs:string
config:directory ( $value as xs:string ) as empty-sequence
Parameters
  • value as xs:string value
Return
  • empty-sequence
Invoked by 0 functions from 0 modules
    Source ( 13 lines)
    function config:directory() as xs:string {
      let $dir := session:get($config:DIRECTORY)
      return if(exists($dir) and file:exists($dir)) then (
        $dir
      ) else (
        $options:DBA-DIRECTORY
      )
    }
    function config:directory(
      $value  as xs:string
    ) as empty-sequence() {
      session:set($config:DIRECTORY, $value)
    }

    4.2 config:query

    Arities: #0#1

    Summary
    Returns the name of the current query.
    Signatures
    config:query ( ) as xs:string?
    config:query ( $value as xs:string ) as empty-sequence
    Parameters
    • value as xs:string value
    Return
    • empty-sequence
    Invoked by 0 functions from 0 modules
      Source ( 9 lines)
      function config:query(
      ) as xs:string? {
        session:get($config:QUERY)
      }
      function config:query(
        $value  as xs:string
      ) as empty-sequence() {
        session:set($config:QUERY, $value)
      }

      4.3 config:query-files

      Arities: #0

      Summary
      Returns the names of all files.
      Signatures
      config:query-files ( ) as xs:string*
      Return
      • xs:string * list of files
      Invoked by 0 functions from 0 modules
        Source ( 5 lines)
        function config:query-files() as xs:string* {
          let $dir := config:directory()
          where file:exists($dir)
          return file:list($dir)[matches(., '\.xqm?$')]
        }

        Namespaces

        The following namespaces are defined:

        PrefixUri
        configdba/config
        filehttp://expath.org/ns/file
        optionsdba/options
        sessionhttp://basex.org/modules/session
        xshttp://www.w3.org/2001/XMLSchema

        6 RestXQ

        None

        Source Code

        (:~
         : DBA configuration.
         :
         : @author Christian Grün, BaseX Team 2005-23, BSD License
         :)
        module namespace config = 'dba/config';
        
        import module namespace options = 'dba/options' at 'options.xqm';
        
        (:~ Session key. :)
        declare variable $config:SESSION-KEY := 'dba';
        (:~ Current directory. :)
        declare %private variable $config:DIRECTORY := 'dba-directory';
        (:~ Current query. :)
        declare %private variable $config:QUERY := 'dba-query';
        
        (:~
         : Returns the current working directory.
         : @return directory
         :)
        declare function config:directory() as xs:string {
          let $dir := session:get($config:DIRECTORY)
          return if(exists($dir) and file:exists($dir)) then (
            $dir
          ) else (
            $options:DBA-DIRECTORY
          )
        };
        
        (:~
         : Assigns a working directory.
         : @param  $value  value
         :)
        declare function config:directory(
          $value  as xs:string
        ) as empty-sequence() {
          session:set($config:DIRECTORY, $value)
        };
        
        (:~
         : Returns the name of the current query.
         : @return current query
         :)
        declare function config:query(
        ) as xs:string? {
          session:get($config:QUERY)
        };
        
        (:~
         : Assigns the name of the current query.
         : @param  $value  value
         :)
        declare function config:query(
          $value  as xs:string
        ) as empty-sequence() {
          session:set($config:QUERY, $value)
        };
        
        (:~
         : Returns the names of all files.
         : @return list of files
         :)
        declare function config:query-files() as xs:string* {
          let $dir := config:directory()
          where file:exists($dir)
          return file:list($dir)[matches(., '\.xqm?$')]
        };