SQLite3 Adapter

.gitignore

@@ -6,4 +6,7 @@ ssl
 *~
 .idea
 nbproject
-npm-debug.log
+npm-debug.log
+
+# Waterline
+sailssqlite.db

Makefile

@@ -0,0 +1,19 @@
+MOCHA_OPTS= --check-leaks
+REPORTER = spec
+
+test: test-unit test-integration
+
+test-unit:
+	@NODE_ENV=test ./node_modules/.bin/mocha \
+						--reporter $(REPORTER) \
+						$(MOCHA_OPTS) \
+						test/unit/**
+
+test-integration:
+	@NODE_ENV=test node test/integration/runner.js
+
+test-load:
+	@NODE_ENV=test ./node_modules/.bin/mocha \
+						--reporter $(REPORTER) \
+						$(MOCHA_OPTS) \
+						test/load/**

README.md

@@ -1,30 +1,63 @@
-![[email protected]](http://i.imgur.com/RIvu9.png) 
+![[email protected]](http://i.imgur.com/RIvu9.png)
 
-# BoilerplateAdapter
+# SQLite3 Sails/Waterline Adapter
 
-This template exists to make it easier for you to get started writing an official adapter for Sails.js.
+A [Waterline](https://github.com/balderdashy/waterline) adapter for SQLite3. May be used in a [Sails](https://github.com/balderdashy/sails) app or anything using Waterline for the ORM.
 
 
+## Disclaimers
+- SQLite3 adapter is not optimized for performance. Native joins are not implemented (among other issues).
+- This codebase contains no unit tests, though all integration tests with the waterline api (v1) pass. (See below for supported interfaces)
+
+#### People who can use this package as is:
+Those prototyping apps with sailsjs 1.x and looking to use sqlite for a test database.
+
+For anyone looking to use this adapter in production, contributions welcome!
+
 ## Getting started
-It's usually pretty easy to add your own adapters for integrating with proprietary systems or existing open APIs.  For most things, it's as easy as `require('some-module')` and mapping the appropriate methods to match waterline semantics.  To get started:
+To use this in your sails app, install using:
+
+> npm install --save sails-sqlite3
+
+In your `config\datastores.js` file, add a property with your datastore name. Supported configuration:
+
+```js
+default: {
+  adapter: 'sails-sqlite3',
+  filename: '[YOUR DATABASE].db',
+  mode: sqlite3.OPEN_READWRITE | sqlite3.OPEN_CREATE,
+  verbose: false
+}
+```
+
+For more information on the `mode` configuration property, see the [driver documentation](https://github.com/mapbox/node-sqlite3/wiki/API#new-sqlite3databasefilename-mode-callback).
+
+#### Example with Modes
+To use different database modes, import the `sqlite3` module, which is a dependency of this pacakge:
+
+```js
+const sqlite3 = require('sqlite3');
+
+const config = {
+  filename: 'testdb.db',
+  mode: sqlite3.OPEN_READONLY,
+  verbose: true
+};
+```
+
+## Testing
 
-1. Fork this repository
-2. Set up your README and package.json file.  Sails.js adapter module names are of the form sails-*, where * is the name of the datastore or service you're integrating with.
-3. Build your adapter.
+> npm test
 
-## How to test your adapter
-1. Run `npm link` in this adapter's directory
-2. Clone the sails.js core and modify the tests to use your new adapter.
-3. Run `npm link sails-boilerplate`
-4. From the sails.js core directory, run `npm test`.
+Currently only `waterline-adapter-tests` are hooked up. Passing interfaces:
 
-## Submitting your adapter
-1. Do a pull request to this repository (make sure you attribute yourself as the author set the license in the package.json to "MIT")  Please let us know about any special instructions for usage/testing.
-2. We'll run the tests one last time.  If there are any issues, we'll let you know.
-3. When it's ready, we'll update the documentation with information about your new adapter
-4. Then we'll tweet and post about it on our blog, adoring you with lavish praises.
-5. Mike will send you jelly beans.
+- semantic
+- queryable
+- associations
+- migratable
 
+## Acknowledgements
+This is a rewrite from a fork of the sails-sqlite3 adapter written for sailsjs < 1.0.0 originally by [Andrew Jo](https://github.com/AndrewJo). I borrowed most of the structure of the code and a lot of the sql querying from the original codebase.
 
 ## About Sails.js and Waterline
 http://SailsJs.com