Skip to content

Latest commit

 

History

History
80 lines (49 loc) · 4.09 KB

README.md

File metadata and controls

80 lines (49 loc) · 4.09 KB
Raw

ewd-document-store

Build Status Coverage Status

Persistent JavaScript Objects and a fine-grained Document Database, using a Global Storage database

Rob Tweed rtweed@mgateway.com
7 March 2016, M/Gateway Developments Ltd http://www.mgateway.com

Twitter: @rtweed

Google Group for discussions, support, advice etc: http://groups.google.co.uk/group/enterprise-web-developer-community

About ewd-document-store

The ewd-document-store module abstracts Global Storage databases as persistent JSON and/or on-disk JavaScript Objects. It is built upon the lower-level Global Storage access APIs provided by a number of other modules:

  • for YottaDB:
  • For InterSystems Cache and IRIS:
    • mg-dbx
    • the cache.node and iris.node modules that are provided by InterSystems

ewd-document-store is the basis of QEWD-JSdb, and provides APIs for a range of database models, including:

  • persistent JSON / on-disk JavaScript Objects
  • Redis-like Lists
  • Redis-like Key/Object store
  • Relational Database with SQL
  • Persistent XML/HTML DOM with XPath

For more information, see the QEWD-JSdb documentation.

Installation

npm install ewd-document-store

Using ewd-document-store

Most users of ewd-document-store will do so through the QEWD framework where it is a tightly-integrated piece of QEWD's core functionality.

It can also be used independently. If you do so, you will also need to ensure that you are using one of the lower-level Global Storage access modules described above.

It is recommended that you consult the QEWD-JSdb documentation for more information.

Integration tests

  • You must have InterSystem Caché installed
  • You must have cache.node in npm global registy. Read Installation to get more details
  • Run npm link cache.node before running integration tests
  • You may need to run this as sudo because of permissions

License

Copyright (c) 2013-20 M/Gateway Developments Ltd,
Reigate, Surrey UK.
All rights reserved.

http://www.mgateway.com
Email: rtweed@mgateway.com

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and
limitations under the License.