dba/files  library module
R

Summary

Create directory.
Tags

Author: Christian Grün, BaseX Team 2005-21, BSD License

__source : files/dir-create.xqm

Related documents
ViewDescriptionFormat
xqdocxqDoc xml file from the source modulexml
xqparsexqparse xml file from the source modulexml

Imports

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

(None)
imports
this
imports

Variables

3.1 $dba:CAT

Summary
Top category
Type
xs:string

Functions

4.1 dba:dir-create

Arities: dba:dir-create#1R

Summary
Creates a directory.
Signature
dba:dir-create ( $name as xs:string )  as element(rest:response)
Parameters
  • name as xs:string name of directory to create
Return
  • element(rest:response)redirection
Invokes 3 functions from 3 modules
  • config:directory#0
  • {http://basex.org/modules/web}redirect#2
  • {http://expath.org/ns/file}create-dir#1
Invoked by 0 functions from 0 modules
    Annotations
    %rest:POST()
    %rest:path('/dba/dir-create')
    %rest:query-param('name','{$name}')
    Source ( 6 lines)
    function dba:dir-create(
      $name  as xs:string
    ) as element(rest:response) {
      file:create-dir(config:directory() || $name),
      web:redirect($dba:CAT, map { 'info': 'Directory "' || $name || '" was created.' })
    }

    Namespaces

    The following namespaces are defined:

    PrefixUri
    configdba/config
    dbadba/files 2 3 4 5 6 7 8
    resthttp://exquery.org/ns/restxq

    6 RestXQ

    Paths defined 1.

    PathMethodFunction
    /dba/dir-createPOSTdba:dir-create#1

    Source Code

    (:~
     : Create directory.
     :
     : @author Christian Grün, BaseX Team 2005-21, BSD License
     :)
    module namespace dba = 'dba/files';
    
    import module namespace config = 'dba/config' at '../lib/config.xqm';
    
    (:~ Top category :)
    declare variable $dba:CAT := 'files';
    
    (:~
     : Creates a directory.
     : @param  $name  name of directory to create
     : @return redirection
     :)
    declare
      %rest:POST
      %rest:path('/dba/dir-create')
      %rest:query-param('name', '{$name}')
    function dba:dir-create(
      $name  as xs:string
    ) as element(rest:response) {
      file:create-dir(config:directory() || $name),
      web:redirect($dba:CAT, map { 'info': 'Directory "' || $name || '" was created.' })
    };