{"id":26052686,"url":"https://github.com/robtweed/ewd-document-store","last_synced_at":"2025-04-10T23:32:34.841Z","repository":{"id":57231519,"uuid":"53341077","full_name":"robtweed/ewd-document-store","owner":"robtweed","description":"Persistent JavaScript Objects and Document Database using Global Storage","archived":false,"fork":false,"pushed_at":"2020-12-16T16:14:17.000Z","size":171,"stargazers_count":7,"open_issues_count":9,"forks_count":3,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-24T20:21:31.273Z","etag":null,"topics":["gtm","intersystems-cache","redis"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/robtweed.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-03-07T16:37:40.000Z","updated_at":"2022-03-19T18:02:25.000Z","dependencies_parsed_at":"2022-09-04T15:04:31.766Z","dependency_job_id":null,"html_url":"https://github.com/robtweed/ewd-document-store","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robtweed%2Fewd-document-store","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robtweed%2Fewd-document-store/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robtweed%2Fewd-document-store/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robtweed%2Fewd-document-store/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/robtweed","download_url":"https://codeload.github.com/robtweed/ewd-document-store/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248316819,"owners_count":21083514,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["gtm","intersystems-cache","redis"],"created_at":"2025-03-08T06:41:46.292Z","updated_at":"2025-04-10T23:32:34.826Z","avatar_url":"https://github.com/robtweed.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ewd-document-store\n\n[![Build Status](https://travis-ci.org/robtweed/ewd-document-store.svg?branch=master)](https://travis-ci.org/robtweed/ewd-document-store) [![Coverage Status](https://coveralls.io/repos/github/robtweed/ewd-document-store/badge.svg?branch=master)](https://coveralls.io/github/robtweed/ewd-document-store?branch=master)\n\nPersistent JavaScript Objects and a fine-grained Document Database, using a Global Storage database\n\nRob Tweed \u003crtweed@mgateway.com\u003e  \n7 March 2016, M/Gateway Developments Ltd [http://www.mgateway.com](http://www.mgateway.com)  \n\nTwitter: [@rtweed](https://twitter.com/rtweed)\n\nGoogle Group for discussions, support, advice etc: [http://groups.google.co.uk/group/enterprise-web-developer-community](http://groups.google.co.uk/group/enterprise-web-developer-community)\n\n\n## About ewd-document-store\n\nThe *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:\n\n- for YottaDB:\n  - [mg-dbx](https://github.com/chrisemunt/mg-dbx)\n  - [NodeM](https://github.com/dlwicksell/nodem)\n- For InterSystems Cache and IRIS:\n  - [mg-dbx](https://github.com/chrisemunt/mg-dbx)\n  - the *cache.node* and *iris.node* modules that are provided by InterSystems\n\n*ewd-document-store* is the basis of [QEWD-JSdb](https://github.com/robtweed/qewd-jsdb), and provides APIs for a range of database models, including:\n\n- persistent JSON / on-disk JavaScript Objects\n- Redis-like Lists\n- Redis-like Key/Object store\n- Relational Database with SQL\n- Persistent XML/HTML DOM with XPath\n\nFor more information, see the [QEWD-JSdb documentation](https://github.com/robtweed/qewd-jsdb).\n\n\n## Installation\n\n    npm install ewd-document-store\n\n\n## Using ewd-document-store\n\nMost users of *ewd-document-store* will do so through the [*QEWD* framework](https://github.com/robtweed/qewd)\nwhere it is a tightly-integrated piece of QEWD's core functionality. \n\nIt 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.\n\nIt is recommended that you consult the [QEWD-JSdb documentation](https://github.com/robtweed/qewd-jsdb) for more information.\n\n\n## Integration tests\n\n  * You must have [InterSystem Caché](http://www.intersystems.com/our-products/cache/cache-overview/) installed\n  * You must have `cache.node` in npm global registy. Read [Installation](http://docs.intersystems.com/latest/csp/docbook/DocBook.UI.Page.cls?KEY=BXJS_intro#BXJS_intro_install) to get more details\n  * Run `npm link cache.node` before running integration tests\n  * You may need to run this as sudo because of permissions\n\n\n## License\n\n Copyright (c) 2013-20 M/Gateway Developments Ltd,                           \n Reigate, Surrey UK.                                                      \n All rights reserved.                                                     \n                                                                           \n  http://www.mgateway.com                                                  \n  Email: rtweed@mgateway.com                                               \n                                                                           \n                                                                           \n  Licensed under the Apache License, Version 2.0 (the \"License\");          \n  you may not use this file except in compliance with the License.         \n  You may obtain a copy of the License at                                  \n                                                                           \n      http://www.apache.org/licenses/LICENSE-2.0                           \n                                                                           \n  Unless required by applicable law or agreed to in writing, software      \n  distributed under the License is distributed on an \"AS IS\" BASIS,        \n  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. \n  See the License for the specific language governing permissions and      \n   limitations under the License.  \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobtweed%2Fewd-document-store","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobtweed%2Fewd-document-store","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobtweed%2Fewd-document-store/lists"}