Skip to content

Generic JSON query object translation to multiple data backends

License

Notifications You must be signed in to change notification settings

chen-factual/franca-js

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Franca-JS

This is a library meant to make it easy to get and view data from different backends. Queries are encoded in a common JSON format that can be translated for use with different data backend sources, such as Mongo or Solr.

Install

npm install franca-js

Usage

franca = require 'franca-js


## Overview

Franca queries are intended to be a common query format for the basic queries common to most data backends. Queries are separated into two parts, one being the core query which captures logic like ```and``` and ```or``` relationships, the other being the auxiliary options like number of rows to return. For SQL for instance, the core queries maps to the logic captured by the WHERE clause, while the auxiliary options would be everything else.

Of course, all data resources have their own quirks and special features, and no common query format can hope to capture all of these for each individual database. Franca queries support a raw mode that allow the user to pass a native query to the backend, exposing the full features of the underlying data resource.


## Common Query Format

The common query format is a JSON object that incorporates basics data query logic. See full documentation [here](https://github.com/chenguo/franca-js/blob/master/docs/query-object.md).


## Query Parser

(TODO)

The query parser translates from a string (for example, from a user typing into an input box) into the common JSON format.

About

Generic JSON query object translation to multiple data backends

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • CoffeeScript 99.5%
  • JavaScript 0.5%