https://github.com/kenmueller/zquery

https://github.com/kenmueller/zquery

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/kenmueller/zquery
• Owner: kenmueller
• Created: 2020-06-20T23:36:06.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T09:27:19.000Z (almost 2 years ago)
• Last Synced: 2024-05-28T15:30:24.949Z (7 months ago)
• Language: TypeScript
• Size: 909 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 14
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# zquery

## About

Relational document-based database.

Includes indexes, filters, and sorting.

Data is auto-denormalized for you: relations between documents are copied data.

## Structure

- _ROOT_

    - /users _COLLECTION_

        - /29adsf1da _DOCUMENT_

            - name: Ken _FIELD_

            - age: 14 _FIELD_

            

            - /projects _SUB-COLLECTION_

                - /8a9d30bac _DOCUMENT-RELATION_ `/projects/8a9d30bac`

    

    - /projects _COLLECTION_

        - /8a9d30bac _DOCUMENT_

            - name: zquery _FIELD_

            - user: `/users/29adsf1da` _DOCUMENT-RELATION_

## Implementation

- Relations can either be entire documents or single fields

- Relations are denormalized data

    - You cannot have a relation to a collection

    - When the source changes, the relation will be automatically updated.

        - We need to keep track of the relations to a given source, inside of the source document

- When a document is queried, sub-collections are not returned. Only the document data and its relations to other documents are returned.

- You can query collections, and it will give you all of the documents underneath and their relations.