Skip to content

Commit b17bfec

Browse files
committed
Fix links and name things in a more straightforward way
1 parent b32e4ef commit b17bfec

29 files changed

+36
-34
lines changed

README.md

+35-33
Original file line numberDiff line numberDiff line change
@@ -49,67 +49,67 @@ First, a quick summary:
4949
Any database or system-- doesn't necessarily need to support persistent connections.
5050

5151
A driver implements the _Connectable_ interface layer if it includes the following machines:
52-
+ [`.createManager()`](./machines/create-manager.js)
53-
+ [`.destroyManager()`](./machines/destroy-manager.js)
54-
+ [`.getConnection()`](./machines/get-connection.js)
55-
+ [`.releaseConnection()`](./machines/release-connection.js)
52+
+ [`.createManager()`](./layers/connectable/create-manager.js)
53+
+ [`.destroyManager()`](./layers/connectable/destroy-manager.js)
54+
+ [`.getConnection()`](./layers/connectable/get-connection.js)
55+
+ [`.releaseConnection()`](./layers/connectable/release-connection.js)
5656

5757
#### Modeled
5858
Any database that fully supports CRUD operations against predefined data models; including basic batch record manipulation, filtering, pagination, and a few of the most common aggregation operations.
5959

6060
A driver implements the _Modeled_ interface layer if it includes the following machines:
61-
+ [`.verifyModelDef()`](./machines/verify-model-def.js)
62-
+ [`.createRecord()`](./machines/create-record.js)
63-
+ [`.createEachRecord()`](./machines/create-each-record.js)
64-
+ [`.updateRecords()`](./machines/update-records.js)
65-
+ [`.destroyRecords()`](./machines/destroy-records.js)
66-
+ [`.findRecords()`](./machines/find-records.js)
67-
+ [`.countRecords()`](./machines/count-records.js)
68-
+ [`.sumRecords()`](./machines/sum-records.js)
69-
+ [`.avgRecords()`](./machines/avg-records.js)
61+
+ [`.verifyModelDef()`](./layers/modeled/verify-model-def.js)
62+
+ [`.createRecord()`](./layers/modeled/create-record.js)
63+
+ [`.createEachRecord()`](./layers/modeled/create-each-record.js)
64+
+ [`.updateRecords()`](./layers/modeled/update-records.js)
65+
+ [`.destroyRecords()`](./layers/modeled/destroy-records.js)
66+
+ [`.findRecords()`](./layers/modeled/find-records.js)
67+
+ [`.countRecords()`](./layers/modeled/count-records.js)
68+
+ [`.sumRecords()`](./layers/modeled/sum-records.js)
69+
+ [`.avgRecords()`](./layers/modeled/avg-records.js)
7070

7171
#### Migratable
7272
Any database or system that supports a concept of tabular data with unique indexes.
7373

7474
A driver implements the _Migratable_ interface layer if it includes the following machines:
75-
+ [`.definePhysicalModel()`](./machines/define-physical-model.js)
76-
+ [`.dropPhysicalModel()`](./machines/drop-physical-model.js)
77-
+ [`.setPhysicalSequence()`](./machines/set-physical-sequence.js)
75+
+ [`.definePhysicalModel()`](./layers/migratable/define-physical-model.js)
76+
+ [`.dropPhysicalModel()`](./layers/migratable/drop-physical-model.js)
77+
+ [`.setPhysicalSequence()`](./layers/migratable/set-physical-sequence.js)
7878

7979
#### Cache
8080
Any database or system which can function as a cache, with native support for key expiry.
8181

8282
A driver implements the _Cache_ interface layer if it includes all machines necessary for _Connectable_, in addition to the following:
8383

84-
+ [`.cacheValue()`](./machines/cache-value.js)
85-
+ [`.getCachedValue()`](./machines/get-cached-value.js)
86-
+ [`.destroyCachedValues()`](./machines/destroy-cached-values.js)
87-
+ [`.flushCache()`](./machines/flush-cache.js)
84+
+ [`.cacheValue()`](./layers/cache/cache-value.js)
85+
+ [`.getCachedValue()`](./layers/cache/get-cached-value.js)
86+
+ [`.destroyCachedValues()`](./layers/cache/destroy-cached-values.js)
87+
+ [`.flushCache()`](./layers/cache/flush-cache.js)
8888

8989
#### Queryable
9090
Any database or system which supports the concept of queries, uniqueness constraints, and tables/collections. Uses [WLQL (stage 4 query)](https://github.com/treelinehq/waterline-query-docs) syntax, which is based on [Knex](http://knexjs.org/).
9191

9292
A driver implements the _Queryable_ IL if it includes all machines nececssary for _Connectable_, in addition to the following:
93-
+ [`.sendNativeQuery()`](./machines/send-native-query.js)
94-
+ [`.compileStatement()`](./machines/compile-statement.js)
95-
+ [`.parseNativeQueryResult()`](./machines/parse-native-query-result.js)
96-
+ [`.parseNativeQueryError()`](./machines/parse-native-query-error.js)
93+
+ [`.sendNativeQuery()`](./layers/queryable/send-native-query.js)
94+
+ [`.compileStatement()`](./layers/queryable/compile-statement.js)
95+
+ [`.parseNativeQueryResult()`](./layers/queryable/parse-native-query-result.js)
96+
+ [`.parseNativeQueryError()`](./layers/queryable/parse-native-query-error.js)
9797

9898
#### Transactional
9999
Any database with native support for transactions.
100100

101101
A driver implements the _Transactional_ IL if it includes all machines nececssary for _Queryable_, in addition to the following:
102102

103-
+ [`.beginTransaction()`](./machines/begin-transaction.js)
104-
+ [`.commitTransaction()`](./machines/commit-transaction.js)
105-
+ [`.rollbackTransaction()`](./machines/rollback-transaction.js)
103+
+ [`.beginTransaction()`](./layers/transactional/begin-transaction.js)
104+
+ [`.commitTransaction()`](./layers/transactional/commit-transaction.js)
105+
+ [`.rollbackTransaction()`](./layers/transactional/rollback-transaction.js)
106106

107107

108108

109109
## Usage
110110

111111
#### Methods
112-
See the [abstract machines](./machines) defined in this repo.
112+
See the [abstract machines](./layers) defined in this repo.
113113

114114
#### Query Language
115115
The Queryable interface layer supports declarative syntax for most types of DQL/DML queries via `compileStatement()`, and the normalized result returned by `parseNativeQueryResult()`. See the [WLQL (stage 4 query) docs](https://github.com/treelinehq/waterline-query-docs/blob/master/docs/) for more information.
@@ -162,18 +162,20 @@ The Waterline driver interface is designed to solve this problem bottom-up, once
162162

163163
## When will there be official support in Sails and/or Waterline?
164164

165+
March, 2017
166+
165167
~~Our primary focus at the moment is to finish, test, and document feature-complete implementations of the supported interface layers for MySQL, MongoDB, and PostgreSQL. Early versions of some drivers are available as of March 2016.~~
166168

167-
> ##### Update:
168-
>As of early Dec 2016, drivers for MySQL, MongoDB, and PostgreSQL are ready to start beating on. They've been out for early testing for almost a year now, and the next version of Waterline (v0.13) / Sails (v1.0) will use them from the respective core adapters. Meanwhile, the Redis driver, which implements the "Cache" IL (instead of "Queryable") is tentatively ready for production use.
169+
> ##### ~~Update~~:
170+
>~~As of early Dec 2016, drivers for MySQL, MongoDB, and PostgreSQL are ready to start beating on. They've been out for early testing for almost a year now, and the next version of Waterline (v0.13) / Sails (v1.0) will use them from the respective core adapters. Meanwhile, the Redis driver, which implements the "Cache" IL (instead of "Queryable") is tentatively ready for production use.~~
169171
>
170-
> See https://github.com/treelinehq/waterline-query-docs/issues/2#issuecomment-186622547 for more discussion about the future of this specification and related APIs in Waterline and the Node-Machine project.
172+
> ~~See https://github.com/treelinehq/waterline-query-docs/issues/2#issuecomment-186622547 for more discussion about the future of this specification and related APIs in Waterline and the Node-Machine project.~~
171173
>
172-
> Contributors will be putting the drivers through a lot more testing over the next 2 weeks, at which point they'll go into the Sails v1 prerelease, then into Sails v1 itself.
174+
> ~~Contributors will be putting the drivers through a lot more testing over the next 2 weeks, at which point they'll go into the Sails v1 prerelease, then into Sails v1 itself.~~
173175
174176

175177

176178
## License
177179

178-
MIT © 2016 [Cody Stoltman](http://github.com/particlebanana), [Mike McNeil](http://github.com/mikermcneil) and contributors
180+
MIT © 2016-2017 [The Sails Company](http://sailsjs.com/studio), [Cody Stoltman](http://github.com/particlebanana), [Mike McNeil](http://github.com/mikermcneil) and contributors
179181

index.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ var UNCONVENTIONAL_METHOD_NAMES = [
2424

2525

2626
var inventory = includeAll({
27-
dirname: path.resolve(__dirname, 'machines/'),
27+
dirname: path.resolve(__dirname, 'layers/'),
2828
filter: /(.+)\.js/,
2929
exclude: [
3030
/^index.js$/
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)