@existdb/node-exist
Advanced tools
+2
-3
@@ -42,4 +42,3 @@ { | ||
| "standard": "^12.0.1", | ||
| "tape": "^4.6.3", | ||
| "travis-deploy-once": "^5.0.1" | ||
| "tape": "^4.6.3" | ||
| }, | ||
@@ -51,3 +50,3 @@ "dependencies": { | ||
| }, | ||
| "version": "1.0.4" | ||
| "version": "2.0.0" | ||
| } |
+51
-44
| # node-exist | ||
| [](https://travis-ci.org/eXist-db/node-exist) | ||
| [](https://travis-ci.com/eXist-db/node-exist) | ||
| [](http://standardjs.com/) | ||
@@ -11,5 +11,9 @@ | ||
| This software is in early development stage and may not be ready for production! | ||
| This software is safe for development but should not be used to alter a production database instance! | ||
| Think twice before your data is lost. | ||
| ## Roadmap | ||
| This package will switch to use eXist-db's REST-API. | ||
| **Use at your own risk.** | ||
@@ -26,47 +30,24 @@ | ||
| ```js | ||
| var exist = require('node-exist') | ||
| const exist = require('@existdb/node-exist') | ||
| const db = exist.connect() | ||
| var db = exist.connect() | ||
| db.collections.create('/db/apps/test') | ||
| .then(result => db.collections.describe('/db/apps/test')) | ||
| .then(result => console.log('collection description:', result)) | ||
| .catch(e => console.error('fail', e)) | ||
| db.collections.create('/db/apps/test') | ||
| .then(function (result) { | ||
| console.log('create returned with:', result) | ||
| return db.collections.describe('/db/apps/test') | ||
| }) | ||
| .then(function (result) { | ||
| console.log('collection description:', result) | ||
| return db.collections.remove('/db/apps/test') | ||
| }) | ||
| .then(function (result) { | ||
| console.log('test collection removed', result) | ||
| }) | ||
| .catch(function (e) { | ||
| console.log('fail', e) | ||
| }) | ||
| ``` | ||
| Uploading an XML file into the database | ||
| ```js | ||
| var exist = require('node-exist') | ||
| const exist = require('@existdb/node-exist') | ||
| const db = exist.connect() | ||
| var db = exist.connect() | ||
| db.documents.upload(Buffer.from('<root/>')) | ||
| .then(fileHandle => db.documents.parseLocal(fileHandle, '/db/apps/test/file.xml', {})) | ||
| .then(result => db.documents.read('/db/apps/test/file.xml')) | ||
| .then(result => console.log('test file contents', result)) | ||
| .catch(e => console.error('fail', e)) | ||
| db.document.upload(Buffer.from('<root/>')) | ||
| .then(function (fileHandle) { | ||
| return db.document.parseLocal(fileHandle, '/db/apps/test/file.xml', {}) | ||
| }) | ||
| .then(function (result) { | ||
| return db.documents.read('/db/apps/test/file.xml') | ||
| }) | ||
| .then(function (result) { | ||
| console.log('test file contents', result) | ||
| return db.documents.remove('/db/apps/test/file.xml') | ||
| }) | ||
| .then(function (result) { | ||
| console.log('test file removed', result) | ||
| }) | ||
| .catch(function (e) { | ||
| console.log('fail', e) | ||
| }) | ||
| ``` | ||
@@ -85,7 +66,11 @@ | ||
| ```js | ||
| db.queries.execute(query, options) | ||
| ``` | ||
| #### read | ||
| ```js | ||
| db.queries.read(query, options) | ||
| ``` | ||
@@ -96,10 +81,17 @@ #### readAll | ||
| ```js | ||
| db.queries.readAll(query, options) | ||
| .then(function (result) { | ||
| result.pages.forEach(function () { | ||
| console.log(page) | ||
| }) | ||
| }) | ||
| ``` | ||
| **Example:** | ||
| ```js | ||
| db.queries.readAll('xquery version "3.1"; xmldb:get-child-collections("/db/apps") => string-join(",\n")', {}) | ||
| .then(result => console.log( | ||
| Buffer.concat(result.pages).toString())) | ||
| .catch(e => console.error(e)) | ||
| ``` | ||
| #### count | ||
@@ -186,3 +178,18 @@ | ||
| ### App | ||
| Status: **Experimental** | ||
| #### upload | ||
| db.app.upload(xarBuffer, xarName) | ||
| #### install | ||
| db.app.install(xarName) | ||
| #### remove | ||
| db.app.remove(xarName) | ||
| ### Indices | ||
@@ -189,0 +196,0 @@ |
Filesystem access
Supply chain riskAccesses the file system, and could potentially read sensitive data.
Found 1 instance in 1 package
Filesystem access
Supply chain riskAccesses the file system, and could potentially read sensitive data.
Found 1 instance in 1 package
3
-25%226
3.2%30138
-0.32%