Drivine is a graph database client for Node.js and TypeScript. It was created with the following design goals:
- Support multiple graph databases (simultaneously, if you wish). Currently AgensGraph and Neo4j (or other BOLT compatible graph DBs).
- Scale to hundreds and thousands of transactions per second, without compromising architectural integrity.
With regards to the second point on scaleability, let's break that down into component facets.
- Facilitates the use of well understood object-oriented and functional programming patterns.
- Supports implementation of code that adheres to a single responsibility principle (SRP). NestJS will be optional, but is recommended.
- Takes care of infrastructure concerns, so that you can focus on making the most of your data.
- Removes boiler plate code, especially the tedious and error-prone kind.
- Supports streaming, without back-pressure. Large amounts of data can be managed in a timely and memory efficient manner.
- Light-weight use-case specific object graph mapping (OGM). Drivine is NOT an OGM in the traditinoal sense. It is inspired by GraphAware CTO Christophe Willemsen's comment that "If you want to be successful at scale with your graph-powered application, then probably don't use an OGM." Instead, with Drivine, your CPYHER queries are king, and each can be performance profiled. The results are then mapped to/from a use-case specific model object.
Follow the Quick Start section in our User Guide or clone the sample app and use it as a starter template.
Start creating repositories like the one below.
@Injectable()
export class RouteRepository {
constructor(
@InjectPersistenceManager() readonly persistenceManager: PersistenceManager,
@InjectCypher('@/traffic/routesBetween') readonly routesBetween: CypherStatement) {
}
@Transactional() // Has default Propagation.REQUIRED - partipicate in a current txn, or start one.
public async findFastestBetween(start: string, destination: string): Promise<Route> {
return this.persistenceManager.getOne(
new QuerySpecification<Route>()
.withStatement(this.routesBetween)
.bind([start, destination])
.limit(1)
.transform(Route)
);
}
}If you use Drivine and your code is public, feel free to make PR and add yourself to the list.
Clone the official sample app and start hacking.
Repository: github.com/liberation-data/drivine-inspiration
This sample is a basic starter template, with some tutorials. It has some endpoints for traffic routing, movies/films and other typical use-cases. Rather than start from scratch, choose the one that closely matches yours, and modify.
New version of slackmap.com is full rewrite with technology update.
The OrientDB was replaced with Neo4j and we choose Drivine as the way to work with the database.
Check out how Drivine supports Neo4j in Full Stack JavaScript App using Angular + Nest + Nx Workspace Monorepo.
Repository: github.com/SlackMap/slackmap
- master branch - not released yet
- develop branch - has all the current work
Best way to learn Drivine is with our User Guide.
New to graph databases? Read some tutorials.
Have a tutorial you'd like to share? Get in touch with me.
If you can't find what you need in the Quick Start or User Guides, please post a question on StackOverflow, using the Drivine tag.
Great! A contribution guide, along with detailed documentation will be published in the coming days.
Please raise a GitHub issue.
Drivine is a non-profit, community driven project. We only ask that if you've found it useful to star us on Github or send a tweet mentioning us (@doctor_cerulean). If you've written a Drivine related blog or tutorial, or published a new Drivine-powered app, we'd certainly be happy to hear about that too.
Drivine is sponsored and led by Jasper Blues with contributions from around the world.
Copyright (c) 2022 Jasper Blues
Drivine is free software: you can redistribute it and/or modify it under the terms of the APACHE LICENSE, VERSION 2.0 as published by the Apache Software Foundation, either version 2 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the Apache Software License, Version 2.0 for more details. You should have received a copy of the Apache Software License along with this program. If not, see http://www.apache.org/licenses/.