Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/usegraffy/graffy
Live queries for graph-shaped data
https://github.com/usegraffy/graffy
data-fetching falcor graphql nodejs streaming-api
Last synced: 1 day ago
JSON representation
Live queries for graph-shaped data
- Host: GitHub
- URL: https://github.com/usegraffy/graffy
- Owner: usegraffy
- License: apache-2.0
- Created: 2018-07-24T16:40:05.000Z (over 6 years ago)
- Default Branch: next
- Last Pushed: 2024-10-23T10:08:17.000Z (22 days ago)
- Last Synced: 2024-11-07T18:58:25.213Z (7 days ago)
- Topics: data-fetching, falcor, graphql, nodejs, streaming-api
- Language: JavaScript
- Homepage: https://graffy.org
- Size: 4.59 MB
- Stars: 45
- Watchers: 1
- Forks: 7
- Open Issues: 13
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Graffy [](https://www.npmjs.com/org/graffy)
Graffy is a toolkit for graph-centric APIs. It has capabilities comparable to GraphQL and Firebase.
## Why?
Graffy supports complex, expressive live queries - with multiple levels of resource expansion and pagination - based on a novel application of [set theory and CRDTs](pages/advanced/01-Theory).
## Client-side example
```js
import Graffy from '@graffy/core';
import GraffyClient from '@graffy/client';
const store = new Graffy();
store.use(new GraffyClient('/api'));
const query = {
posts: [{ last: 10 }, { // Pagination parameters
title: true,
author: { name: true }
}]
};
for await (const state of store.watch(query)) {
// Iterates each time relevant data changes on the server.
console.log(state);
}
```
## Why Graffy?
Graffy provides [live queries](pages/why/02-LiveQueries.md), which give clients a real-time view of the data they need. Graffy supports complex queries with nested graph traversals and pagination, while exposing a simple and intuitive API for building clients and servers.
Graffy was inspired by (and borrows from) Facebook's GraphQL and Netflix's Falcor. Compared to GraphQL, Graffy offers a more familiar data model, true live queries and more efficient caching. Compared to Falcor, it provides cursor-based pagination and real-time subscriptions.
Unlike GraphQL resolvers and Falcor data providers, Graffy providers can be _composed_ like Express/Koa middleware. This allows authentication, validation, custom caches and resource limiting to be implemented in a straightforward manner.
Graffy providers can also perform efficient bulk reads from underlying data stores (for example by constructing optimized SQL queries). This is particularly hard to do with GraphQL (see dataloader) and Falcor.
## [Documentation](https://graffy.js.org)
## Modules
The [graffy](https://www.npmjs.com/package/graffy) metapackage exports a constructor for a Graffy store in its default configuration.
All the Graffy packages are published under the [@graffy scope](https://www.npmjs.com/org/graffy) on NPM.
| Module | Description |
| -------- | ----------------------------------- |
| core | Module management |
| fill | Fulfil queries from many providers |
| client | EventStream/HTTP client |
| server | EventStream/HTTP server |
| cache | In-memory cache |
| common | Shared utilities |
| react | React container and hooks API |
| stream | Utility for making AsyncIterables |
| testing | Testing and debugging utilities |
| graphql | Translate GraphQL to Graffy |
| schema | ⌛ Validation, introspection API |
| viewer | ⌛ Schema introspection client |
| auth | ⌛ Authentication and authorization |
| limit | ⌛ Resource consumption accounting |
| mysql | ⌛ Data source connector |
| postgres | ⌛ Data source connector |
⌛ = On the roadmap.
## Capabilities
| | Graffy | GraphQL | Falcor | Description |
| ------------------ | :--: | :-----: | :----: | -------------------------------------------------------- |
| Narrow queries | ✅ | ✅ | ✅ | Queries specify required fields; Allows API evolution |
| Deep queries | ✅ | ✅ | ✅ | Queries can expand nested resources; Reduces round-trips |
| Live queries | ✅ | ❌ | ❌ | Push changes to query results in real time |
| Pagination cursors | ✅ | ✅ | ❌ | Enables efficient pagination on the server |
| Parameters | ✅ | ✅ | ❌ | Custom filtering criteria, etc. |
| Caching pages | ✅ | ❌ | ✅ | Cache result of paginated queries |
| Atomic writes | ✅ | ❌ | ✅ | Writes that trigger accurate cache invalidation |
| Non-data endpoints | ✅ | ✅ | ❌ | Mutations, subscriptions, cross-resource search |