You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+15-7
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,9 @@
1
1
## About
2
2
3
-
JugglingDB -- cross-db ORM, providing **common interface** to access most popular database formats. Currently supported: mysql, mongodb, redis, neo4j and js-memory-storage (yep, self-written engine for test-usage only). You can add your favorite database adapter, checkout one of existing adapters to learn how, it's super-easy, I guarantee.
3
+
JugglingDB is cross-db ORM, providing **common interface** to access most popular database formats.
4
+
Currently supported are: mysql, mongodb, redis, neo4j and js-memory-storage (yep,
5
+
self-written engine for test-usage only). You can add your favorite database adapter, checkout one of the
6
+
existing adapters to learn how, it's super-easy, I guarantee.
4
7
5
8
## Installation
6
9
@@ -79,7 +82,7 @@ Read the tests for usage examples: ./test/common_test.js
79
82
80
83
## Your own database adapter
81
84
82
-
To use custom adapter, pass it package name as first argument to Schema constructor:
85
+
To use custom adapter, pass it's package name as first argument to `Schema` constructor:
83
86
84
87
mySchema = new Schema('couch-db-adapter', {host:.., port:...});
85
88
@@ -89,11 +92,12 @@ Make sure, your adapter can be required (just put it into ./node_modules):
89
92
90
93
## Running tests
91
94
92
-
All tests written using nodeunit:
95
+
All tests are written using nodeunit:
93
96
94
97
nodeunit test/common_test.js
95
98
96
-
If you run this line, of course it will fall, because it requres different databases to be up and running, but you can use js-memory-engine out of box! Specify ONLY env var:
99
+
If you run this line, of course it will fall, because it requres different databases to be up and running,
100
+
but you can use js-memory-engine out of box! Specify ONLY env var:
97
101
98
102
ONLY=memory nodeunit test/common_test.js
99
103
@@ -103,13 +107,17 @@ of course, if you have redis running, you can run
103
107
104
108
## Package structure
105
109
106
-
Now all common logic desribed in ./index.js, and database-specific stuff in ./lib/*.js. It super-tiny, yep?
110
+
Now all common logic described in ./index.js, and database-specific stuff in ./lib/*.js. It's super-tiny, right?
107
111
108
112
## Project status
109
113
110
-
This project written in one weekend (1,2 oct 2011), and of course it not pretend to be preduction-ready, but I plan to use this project as default ORM for RailwayJS in nearest future. So, if you familiar with some database engines - please help me to improve adapter for that database.
114
+
This project was written in one weekend (1,2 oct 2011), and of course does not claim to be production-ready,
115
+
but I plan to use this project as default ORM for RailwayJS in nearest future.
116
+
So, if you are familiar with some database engines - please help me to improve adapter for that database.
111
117
112
-
For example, I know, mysql implementation sucks now, 'cause I'm not digging too deep into SequelizeJS code, and I think would be better to replace sequelize with something low-level in nearest future, such as `mysql` package from npm.
118
+
For example, I know, mysql implementation sucks now, 'cause I'm not digging too deep into SequelizeJS code,
119
+
and I think it would be better to replace sequelize with something low-level in nearest future, such
0 commit comments