gulp-exist
A gulp plugin to deploy to and query an eXist-db using eXist's XML-RPC API.
Usage
gulp deploy
will store all files in the build
directory to
/db/apps/myapp collection in eXist.
var gulp = exist = // authenticate against eXistvar connectionOptions = basic_auth: user: "admin" pass: "****************" var exClient = exist // send allgulp
NOTE: Non-existing collections and sub-folders will be created automatically.
exist.createClient(options)
Returns a set of functions to interact with an eXist-db instance. What you can do is dependent on the permissions of the user specified in the connection options.
NOTE: The connection options are passed through to the XMLRPC client library. So it might be possible to use different authentication methods or to pass in more options than mentioned below as long as your eXist-db installation understands them.
Options
host
Type: string
Default: 'localhost'
port
Type: number
Default: 8080
path
Path to eXist's XML-RPC endpoint
Type: string
Default: '/exist/xmlrpc'
basic_auth
Required
Type: Object
Default: { user: 'guest', pass: 'guest' }
Example
var exClient = exist
existClient.dest(options)
Uploads input files to a target collection in eXist.
Options
target
Remote deployment target collection. Non-existent collections will be created.
Type: string
Default '/db'
html5AsBinary
When set to true, any HTML file that cannot be parsed as valid XML, will be uploaded as a binary file instead. HTML5 documents tend to be non well-formed XML.
Formerly binary_fallback
.
NOTE: Binary documents can not be indexed and therefore are also not
searchable by the eXist-db. This option is only useful for template files.
Type: boolean
Default: false
permissions
Specify remote permissions for files as path-permission pairs.
Type: Object{path: permissions}
Default: {}
'.secrets/key': 'rwx------' 'controller.xql': 'rwxr-xr-x'
Example
var exClient = exist gulp
existClient.newer(options)
Filters the input stream for files that are newer than their remote counterpart.
Options
target
Which collection to compare the local files to.
Example
Only upload modified files.
var gulp = exist = // override defaultsvar connectionOptions = basic_auth: user: 'admin' pass: '****************' var exClient = existvar targetOptions = target: '/db/apps/myapp/' // the collection to write html5AsBinary: true // upload HTML5 templates as binary gulp;
existClient.query(options)
Execute input files as XQuery on the server.
The input files will not be stored in eXist but read locally and executed directly. The query results will be logged in the console (can be disabled by setting printXqlResults
to false
). For each input file, the result of the query will also be emitted as an output file that can optionally be copied into a local directory for logging. Timestamps will be appended to the filename. The filename extension of the output files can be controlled with xqlOutputExt
(default is xml
).
Query options
printXqlResults
Whether to print the results of executed XQuerys to console.
Type: boolean
Default: true
xqlOutputExt
The filename extension that will be used for XQuery result files emitted by exist.query()
.
Type: string
Default: 'xml'
Example
Upload a collection index configuration file and re-index the collection
scripts/reindex.xql
xquery version "3.1";declare option exist:serialize "method=json media-type=text/javascript";<result> <success>{xmldb:reindex('/db/apps/myapp/data')}</success></result>
gulpfile.js
var gulp = exist = // override defaultsvar connectionOptions = basic_auth: user: "admin" pass: "****************" var exClient = exist var exist_config = target: '/db/system/config/db/apps/myapp/data' xqlOutputExt: 'json'; gulp; gulp;
Define Custom Mime Types
Override the mime type used to store files in exist based on their extension.
defineMimeTypes
just exposes mime.define()
.
Extended by default:
{ 'application/xquery': ['xq', 'xql', 'xqm'], 'application/xml': ['xconf'] }
Type: Object{mimetype: [extensions]}
Example
exist
More examples
Watch
gulp watch
will automatically upload files on change
var gulp = exist = sass = watch = newer = ; var exitClient = exist; // compile SCSS styles and put them into 'build/app/css'gulp; // copy html templates, XMLs and XQuerys to 'build'gulp; gulp; gulp; gulp; gulp; gulp;
Make XAR Archive
var gulp = exist = zip = gulp);
Test
Prerequisites
A running instance of eXist-db v2.2+ at localhost port 8080 with an admin user that has a blank password.
Run the Tests
npm test