Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crufter/squery
https://github.com/crufter/squery
Last synced: 22 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/crufter/squery
- Owner: crufter
- Created: 2014-07-10T17:32:50.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2014-07-12T13:48:25.000Z (over 10 years ago)
- Last Synced: 2024-11-30T21:48:47.929Z (23 days ago)
- Language: Go
- Size: 164 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
squery
======
***WHAT YOU READ HERE IS PROBABLY WRONG. YOU HAVE BEEN WARNED. Please if you know an existing implementation tell me, because though I love programming I love sleeping more.***
What is squery?
---
- A microservices protocol and library which helps you query your services as easily as you query the dom with jquery, or your database with SQL*
*Almost correct, keep reading
The problems
---
A microservices based architecture has plenty of benefits, but unfortunately it has drawbacks as well: it is quite hard to do more complex queries involving multiple services. This project helps you keep your services lousely coupled.
The solution
---
Crawl the data, copy it and precompute your views! This way you can ask your system high level questions without sacrificing performance or violating service boundaries!
***Steps involved***:
- each entity in your services must provide a way to be crawled (to be specified)
- for each entity you must define a schema, most importantly the foreign keys referring to an entity in an other service
- the hard part: build a service which can pull data from the services and precompute views based on the queries you make. An example implementation + tooling to help implementation will be done by the author of this project
- when that service is ready use this library as a driver to query your data
In action
---
Once the services define their schemas for the entities, and provide a way to be crawled, we can use a library to query the data in the following (nothing is set in stone) fashion:
Querying customers of company with id 23
```go
api.Query("customer").RefersTo(api.Query("company").Id(23))
```
Querying the financial records of a customer for a given month
```go
api.Query("finance.entry").RefersTo(api.Query("customer").Id(97)).Between("timeStamp", monthBegin, monthEnd)
```
The referred entities can be filtered:
```go
api.Query("players").RefersTo(api.Query("guilds").Equals("guildType", "pro"))
```
These queries can be analyzed, and a view can be precomputed to return the data efficiently exactly the way you want. This lets you express your requirement in a high level fashion.