meadow 2.0.41 → 2.0.42
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -17
- package/docs/_cover.md +1 -1
- package/docs/_topbar.md +1 -1
- package/docs/_version.json +2 -2
- package/docs/providers/README.md +9 -9
- package/docs/providers/alasql.md +3 -3
- package/docs/providers/meadow-endpoints.md +6 -6
- package/docs/providers/mongodb.md +5 -5
- package/docs/providers/mssql.md +3 -3
- package/docs/providers/mysql.md +3 -3
- package/docs/providers/postgresql.md +5 -5
- package/docs/providers/rocksdb.md +4 -4
- package/docs/providers/sqlite.md +4 -4
- package/docs/query/README.md +1 -1
- package/docs/query-dsl.md +1 -1
- package/docs/quick-start.md +1 -1
- package/docs/retold-catalog.json +302 -213
- package/docs/retold-keyword-index.json +18147 -13014
- package/package.json +9 -9
- package/source/Meadow.js +1 -0
- package/source/providers/Meadow-Provider-ALASQL.js +1 -1
- package/source/providers/Meadow-Provider-Oracle.js +459 -0
package/README.md
CHANGED
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# Meadow
|
|
2
2
|
|
|
3
|
+
> **[▶ Read the Meadow Documentation](https://fable-retold.github.io/meadow/)** — interactive docs with the full API reference.
|
|
4
|
+
|
|
3
5
|
A data access library providing magic where you want it, programmability where you don't.
|
|
4
6
|
|
|
5
7
|
[](https://badge.fury.io/js/meadow)
|
|
@@ -144,12 +146,12 @@ meadow.doReads(meadow.query.setCap(25).setBegin(0),
|
|
|
144
146
|
|
|
145
147
|
| Provider | Description | Connection Module |
|
|
146
148
|
|----------|-------------|-------------------|
|
|
147
|
-
| `MySQL` | MySQL/MariaDB via mysql2 | [meadow-connection-mysql](https://github.com/
|
|
148
|
-
| `MSSQL` | Microsoft SQL Server | [meadow-connection-mssql](https://github.com/
|
|
149
|
-
| `PostgreSQL` | PostgreSQL | [meadow-connection-postgresql](https://github.com/
|
|
150
|
-
| `SQLite` | Embedded SQLite via better-sqlite3 | [meadow-connection-sqlite](https://github.com/
|
|
151
|
-
| `MongoDB` | MongoDB document store | [meadow-connection-mongodb](https://github.com/
|
|
152
|
-
| `RocksDB` | Embedded key-value store | [meadow-connection-rocksdb](https://github.com/
|
|
149
|
+
| `MySQL` | MySQL/MariaDB via mysql2 | [meadow-connection-mysql](https://github.com/fable-retold/meadow-connection-mysql) |
|
|
150
|
+
| `MSSQL` | Microsoft SQL Server | [meadow-connection-mssql](https://github.com/fable-retold/meadow-connection-mssql) |
|
|
151
|
+
| `PostgreSQL` | PostgreSQL | [meadow-connection-postgresql](https://github.com/fable-retold/meadow-connection-postgresql) |
|
|
152
|
+
| `SQLite` | Embedded SQLite via better-sqlite3 | [meadow-connection-sqlite](https://github.com/fable-retold/meadow-connection-sqlite) |
|
|
153
|
+
| `MongoDB` | MongoDB document store | [meadow-connection-mongodb](https://github.com/fable-retold/meadow-connection-mongodb) |
|
|
154
|
+
| `RocksDB` | Embedded key-value store | [meadow-connection-rocksdb](https://github.com/fable-retold/meadow-connection-rocksdb) |
|
|
153
155
|
| `ALASQL` | In-browser IndexedDB via ALASQL | Built-in |
|
|
154
156
|
| `MeadowEndpoints` | REST proxy to remote Meadow API | Built-in |
|
|
155
157
|
| `None` | No-op stub for testing | None required |
|
|
@@ -170,17 +172,17 @@ npx docsify-cli serve docs
|
|
|
170
172
|
|
|
171
173
|
## Related Packages
|
|
172
174
|
|
|
173
|
-
- [foxhound](https://github.com/
|
|
174
|
-
- [stricture](https://github.com/
|
|
175
|
-
- [meadow-endpoints](https://github.com/
|
|
176
|
-
- [meadow-connection-mysql](https://github.com/
|
|
177
|
-
- [meadow-connection-mssql](https://github.com/
|
|
178
|
-
- [meadow-connection-sqlite](https://github.com/
|
|
179
|
-
- [meadow-connection-postgresql](https://github.com/
|
|
180
|
-
- [meadow-connection-mongodb](https://github.com/
|
|
181
|
-
- [meadow-connection-rocksdb](https://github.com/
|
|
182
|
-
- [fable](https://github.com/
|
|
183
|
-
- [orator](https://github.com/
|
|
175
|
+
- [foxhound](https://github.com/fable-retold/foxhound) -- query DSL for SQL and NoSQL generation
|
|
176
|
+
- [stricture](https://github.com/fable-retold/stricture) -- schema definition language
|
|
177
|
+
- [meadow-endpoints](https://github.com/fable-retold/meadow-endpoints) -- automatic REST endpoint generation
|
|
178
|
+
- [meadow-connection-mysql](https://github.com/fable-retold/meadow-connection-mysql) -- MySQL connection provider
|
|
179
|
+
- [meadow-connection-mssql](https://github.com/fable-retold/meadow-connection-mssql) -- MSSQL connection provider
|
|
180
|
+
- [meadow-connection-sqlite](https://github.com/fable-retold/meadow-connection-sqlite) -- SQLite connection provider
|
|
181
|
+
- [meadow-connection-postgresql](https://github.com/fable-retold/meadow-connection-postgresql) -- PostgreSQL connection provider
|
|
182
|
+
- [meadow-connection-mongodb](https://github.com/fable-retold/meadow-connection-mongodb) -- MongoDB connection provider
|
|
183
|
+
- [meadow-connection-rocksdb](https://github.com/fable-retold/meadow-connection-rocksdb) -- RocksDB connection provider
|
|
184
|
+
- [fable](https://github.com/fable-retold/fable) -- application services framework
|
|
185
|
+
- [orator](https://github.com/fable-retold/orator) -- API server abstraction
|
|
184
186
|
|
|
185
187
|
## License
|
|
186
188
|
|
package/docs/_cover.md
CHANGED
package/docs/_topbar.md
CHANGED
package/docs/_version.json
CHANGED
package/docs/providers/README.md
CHANGED
|
@@ -32,10 +32,10 @@ Every provider implements the same operation set:
|
|
|
32
32
|
|
|
33
33
|
| Provider | Best For | Connection Module |
|
|
34
34
|
|----------|----------|-------------------|
|
|
35
|
-
| [MySQL](
|
|
36
|
-
| [MSSQL](
|
|
37
|
-
| [SQLite](
|
|
38
|
-
| [ALASQL](
|
|
35
|
+
| [MySQL](mysql.md) | Production web applications, MySQL/MariaDB | [meadow-connection-mysql](https://github.com/fable-retold/meadow-connection-mysql) |
|
|
36
|
+
| [MSSQL](mssql.md) | Enterprise environments, SQL Server | [meadow-connection-mssql](https://github.com/fable-retold/meadow-connection-mssql) |
|
|
37
|
+
| [SQLite](sqlite.md) | Embedded applications, local development | [meadow-connection-sqlite](https://github.com/fable-retold/meadow-connection-sqlite) |
|
|
38
|
+
| [ALASQL](alasql.md) | Browser applications, unit testing, prototyping | Built-in (no external connection) |
|
|
39
39
|
| MeadowEndpoints | Client-side proxy to remote Meadow APIs | Built-in (HTTP via simple-get) |
|
|
40
40
|
| None | Unit testing stubs, development scaffolding | None required |
|
|
41
41
|
|
|
@@ -241,13 +241,13 @@ meadow.doRead(meadow.query.addFilter('IDBook', 1),
|
|
|
241
241
|
|
|
242
242
|
## Provider-Specific Documentation
|
|
243
243
|
|
|
244
|
-
- [MySQL](
|
|
245
|
-
- [MSSQL](
|
|
246
|
-
- [SQLite](
|
|
247
|
-
- [ALASQL](
|
|
244
|
+
- [MySQL](mysql.md) -- Connection pooling, named placeholders, configuration
|
|
245
|
+
- [MSSQL](mssql.md) -- Prepared statements, type mapping, identity handling
|
|
246
|
+
- [SQLite](sqlite.md) -- Embedded database, lightweight deployment
|
|
247
|
+
- [ALASQL](alasql.md) -- In-memory SQL, dynamic table creation, browser support
|
|
248
248
|
|
|
249
249
|
## Related Documentation
|
|
250
250
|
|
|
251
251
|
- [Schema](schema/README.md) -- How schema definitions drive provider behavior
|
|
252
252
|
- [Query Overview](query/README.md) -- FoxHound query DSL and dialect generation
|
|
253
|
-
- [Meadow-Endpoints](https://github.com/
|
|
253
|
+
- [Meadow-Endpoints](https://github.com/fable-retold/meadow-endpoints) -- REST API generation on top of Meadow providers
|
package/docs/providers/alasql.md
CHANGED
|
@@ -265,7 +265,7 @@ All operations are wrapped in try-catch blocks. Errors are stored in `pQuery.par
|
|
|
265
265
|
|
|
266
266
|
## Related Documentation
|
|
267
267
|
|
|
268
|
-
- [Providers Overview](
|
|
269
|
-
- [MySQL Provider](
|
|
270
|
-
- [SQLite Provider](
|
|
268
|
+
- [Providers Overview](README.md) -- Comparison of all providers
|
|
269
|
+
- [MySQL Provider](mysql.md) -- Production MySQL alternative
|
|
270
|
+
- [SQLite Provider](sqlite.md) -- Lightweight embedded alternative
|
|
271
271
|
- [Schema](schema/README.md) -- Schema definitions that drive table creation
|
|
@@ -91,7 +91,7 @@ Each Meadow CRUD operation maps to a standard HTTP method:
|
|
|
91
91
|
| `PUT` | Update | `/{prefix}{Scope}` |
|
|
92
92
|
| `DELETE` | Delete | `/{prefix}{Scope}/{ID}` |
|
|
93
93
|
|
|
94
|
-
This mapping follows the standard Meadow REST conventions generated by [meadow-endpoints](https://github.com/
|
|
94
|
+
This mapping follows the standard Meadow REST conventions generated by [meadow-endpoints](https://github.com/fable-retold/meadow-endpoints) on the server side.
|
|
95
95
|
|
|
96
96
|
## Cookie and Header Forwarding
|
|
97
97
|
|
|
@@ -238,7 +238,7 @@ graph LR
|
|
|
238
238
|
- **Client side:** Meadow uses MeadowEndpoints to proxy the same operations over HTTP to the server's REST API
|
|
239
239
|
- **Application code:** Identical CRUD calls in both environments
|
|
240
240
|
|
|
241
|
-
This pattern is especially powerful when combined with [meadow-endpoints](https://github.com/
|
|
241
|
+
This pattern is especially powerful when combined with [meadow-endpoints](https://github.com/fable-retold/meadow-endpoints) on the server, which auto-generates REST routes from Meadow entity definitions.
|
|
242
242
|
|
|
243
243
|
## Full Setup Example
|
|
244
244
|
|
|
@@ -303,7 +303,7 @@ HTTP-related errors follow the standard pattern:
|
|
|
303
303
|
|
|
304
304
|
## Related Documentation
|
|
305
305
|
|
|
306
|
-
- [Providers Overview](
|
|
307
|
-
- [MySQL Provider](
|
|
308
|
-
- [ALASQL Provider](
|
|
309
|
-
- [meadow-endpoints](https://github.com/
|
|
306
|
+
- [Providers Overview](README.md) -- Comparison of all providers
|
|
307
|
+
- [MySQL Provider](mysql.md) -- Server-side database provider
|
|
308
|
+
- [ALASQL Provider](alasql.md) -- Client-side in-memory alternative
|
|
309
|
+
- [meadow-endpoints](https://github.com/fable-retold/meadow-endpoints) -- Server-side REST API generation
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> Document-based storage with automatic counter management and sentinel value support
|
|
4
4
|
|
|
5
|
-
The MongoDB provider connects Meadow to MongoDB databases via the [meadow-connection-mongodb](https://github.com/
|
|
5
|
+
The MongoDB provider connects Meadow to MongoDB databases via the [meadow-connection-mongodb](https://github.com/fable-retold/meadow-connection-mongodb) module. It uses the FoxHound MongoDB dialect for query generation, providing document-based storage without schema migration. Auto-increment counters, GUID generation, and timestamp sentinels are handled automatically.
|
|
6
6
|
|
|
7
7
|
## Setup
|
|
8
8
|
|
|
@@ -313,7 +313,7 @@ docker run -d \
|
|
|
313
313
|
|
|
314
314
|
## Related Documentation
|
|
315
315
|
|
|
316
|
-
- [Providers Overview](
|
|
317
|
-
- [MySQL Provider](
|
|
318
|
-
- [ALASQL Provider](
|
|
319
|
-
- [meadow-connection-mongodb](https://github.com/
|
|
316
|
+
- [Providers Overview](README.md) -- Comparison of all providers
|
|
317
|
+
- [MySQL Provider](mysql.md) -- Relational database alternative
|
|
318
|
+
- [ALASQL Provider](alasql.md) -- In-memory alternative
|
|
319
|
+
- [meadow-connection-mongodb](https://github.com/fable-retold/meadow-connection-mongodb) -- Connection module source
|
package/docs/providers/mssql.md
CHANGED
|
@@ -291,6 +291,6 @@ docker run -d \
|
|
|
291
291
|
|
|
292
292
|
## Related Documentation
|
|
293
293
|
|
|
294
|
-
- [Providers Overview](
|
|
295
|
-
- [MySQL Provider](
|
|
296
|
-
- [meadow-connection-mssql](https://github.com/
|
|
294
|
+
- [Providers Overview](README.md) -- Comparison of all providers
|
|
295
|
+
- [MySQL Provider](mysql.md) -- MySQL/MariaDB alternative
|
|
296
|
+
- [meadow-connection-mssql](https://github.com/fable-retold/meadow-connection-mssql) -- Connection module source
|
package/docs/providers/mysql.md
CHANGED
|
@@ -255,6 +255,6 @@ docker run -d \
|
|
|
255
255
|
|
|
256
256
|
## Related Documentation
|
|
257
257
|
|
|
258
|
-
- [Providers Overview](
|
|
259
|
-
- [MSSQL Provider](
|
|
260
|
-
- [meadow-connection-mysql](https://github.com/
|
|
258
|
+
- [Providers Overview](README.md) -- Comparison of all providers
|
|
259
|
+
- [MSSQL Provider](mssql.md) -- Microsoft SQL Server alternative
|
|
260
|
+
- [meadow-connection-mysql](https://github.com/fable-retold/meadow-connection-mysql) -- Connection module source
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> Production-ready PostgreSQL integration with connection pooling and named parameter binding
|
|
4
4
|
|
|
5
|
-
The PostgreSQL provider connects Meadow to PostgreSQL databases via the [meadow-connection-postgresql](https://github.com/
|
|
5
|
+
The PostgreSQL provider connects Meadow to PostgreSQL databases via the [meadow-connection-postgresql](https://github.com/fable-retold/meadow-connection-postgresql) module. It uses the FoxHound PostgreSQL dialect for query generation and supports named parameter binding with positional placeholders ($1, $2, etc.).
|
|
6
6
|
|
|
7
7
|
## Setup
|
|
8
8
|
|
|
@@ -306,7 +306,7 @@ docker run -d \
|
|
|
306
306
|
|
|
307
307
|
## Related Documentation
|
|
308
308
|
|
|
309
|
-
- [Providers Overview](
|
|
310
|
-
- [MySQL Provider](
|
|
311
|
-
- [MSSQL Provider](
|
|
312
|
-
- [meadow-connection-postgresql](https://github.com/
|
|
309
|
+
- [Providers Overview](README.md) -- Comparison of all providers
|
|
310
|
+
- [MySQL Provider](mysql.md) -- MySQL/MariaDB alternative
|
|
311
|
+
- [MSSQL Provider](mssql.md) -- Microsoft SQL Server alternative
|
|
312
|
+
- [meadow-connection-postgresql](https://github.com/fable-retold/meadow-connection-postgresql) -- Connection module source
|
|
@@ -291,7 +291,7 @@ All operations follow the same error handling pattern:
|
|
|
291
291
|
|
|
292
292
|
## Related Documentation
|
|
293
293
|
|
|
294
|
-
- [Providers Overview](
|
|
295
|
-
- [SQLite Provider](
|
|
296
|
-
- [ALASQL Provider](
|
|
297
|
-
- [meadow-connection-rocksdb](https://github.com/
|
|
294
|
+
- [Providers Overview](README.md) -- Comparison of all providers
|
|
295
|
+
- [SQLite Provider](sqlite.md) -- Embedded SQL alternative
|
|
296
|
+
- [ALASQL Provider](alasql.md) -- In-memory SQL alternative
|
|
297
|
+
- [meadow-connection-rocksdb](https://github.com/fable-retold/meadow-connection-rocksdb) -- Connection module source
|
package/docs/providers/sqlite.md
CHANGED
|
@@ -167,7 +167,7 @@ The SQLite provider follows the same error handling pattern as MySQL:
|
|
|
167
167
|
|
|
168
168
|
## Related Documentation
|
|
169
169
|
|
|
170
|
-
- [Providers Overview](
|
|
171
|
-
- [MySQL Provider](
|
|
172
|
-
- [ALASQL Provider](
|
|
173
|
-
- [meadow-connection-sqlite](https://github.com/
|
|
170
|
+
- [Providers Overview](README.md) -- Comparison of all providers
|
|
171
|
+
- [MySQL Provider](mysql.md) -- MySQL/MariaDB for production
|
|
172
|
+
- [ALASQL Provider](alasql.md) -- In-memory alternative
|
|
173
|
+
- [meadow-connection-sqlite](https://github.com/fable-retold/meadow-connection-sqlite) -- Connection module source
|
package/docs/query/README.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
> Building and configuring queries with the FoxHound DSL
|
|
4
4
|
|
|
5
|
-
Every data operation in Meadow begins with a query object. Meadow uses [FoxHound](https://github.com/
|
|
5
|
+
Every data operation in Meadow begins with a query object. Meadow uses [FoxHound](https://github.com/fable-retold/foxhound) as its query DSL, generating dialect-specific SQL from a fluent, chainable API. You never need to construct FoxHound directly -- Meadow gives you a fresh, pre-configured query every time you access the `.query` property.
|
|
6
6
|
|
|
7
7
|
## Getting a Query Object
|
|
8
8
|
|
package/docs/query-dsl.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Query DSL
|
|
2
2
|
|
|
3
|
-
Meadow uses [FoxHound](https://github.com/
|
|
3
|
+
Meadow uses [FoxHound](https://github.com/fable-retold/foxhound) as its query DSL. FoxHound provides a fluent, chainable API for building database queries without writing raw SQL. Meadow wraps FoxHound and manages query lifecycle, cloning, and schema injection.
|
|
4
4
|
|
|
5
5
|
## Getting a Query
|
|
6
6
|
|
package/docs/quick-start.md
CHANGED
|
@@ -4,7 +4,7 @@ This guide walks you through installing Meadow, connecting to a database, and pe
|
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
|
-
Meadow requires [Fable](https://github.com/
|
|
7
|
+
Meadow requires [Fable](https://github.com/fable-retold/fable) as its runtime container and a connection module for your chosen database. Install all three:
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
10
|
npm install meadow fable meadow-connection-mysql
|