Skip to content

MongoDBGrammar

MongoDB query grammar (converts SQL-like operations to MongoDB operations) Outputs string directives like "collection:operation:payload" to be interpreted by the driver.

compileSelect

Converts a SQL-like SELECT into a MongoDB find directive.

Parameters

NameDescription
queryQuery components including from, wheres, orders, etc.

returnsstring — - Directive string "collection:find:{filter,options}".

compileInsert

Converts INSERT into insertOne or insertMany directive.

Parameters

NameDescription
queryQuery components including table and values.

returnsstring — - Directive string for insert operation.

compileUpdate

Converts UPDATE into updateMany directive with $set.

Parameters

NameDescription
queryQuery components including table, wheres, and values.

returnsstring — - Directive string for update operation.

compileDelete

Converts DELETE into deleteMany directive.

Parameters

NameDescription
queryQuery components including table and wheres.

returnsstring — - Directive string for delete operation.

compileWheres

Builds MongoDB filter object from SQL-like where clauses.

Parameters

NameDescription
wheresArray of where clause objects.

returnsstring — - MongoDB filter object.

addBasicWhere

Adds basic comparison operators to MongoDB filter.

Parameters

NameDescription
filterThe filter object to mutate.
wWhere clause object.

compileOptions

Builds MongoDB cursor options (projection, sort, skip, limit).

Parameters

NameDescription
queryQuery components including columns, orders, limit, offset.

returnsstring — - MongoDB find options object.

wrapTable

Wraps a collection name. MongoDB collections require no special wrapping.

Parameters

NameDescription
tableCollection name.

returnsstring — - The unmodified collection name.

wrapColumn

Wraps a field/column name. MongoDB fields require no special wrapping.

Parameters

NameDescription
columnField name.

returnsstring — - The unmodified field name.

parameter

Formats a parameter for directive payload. JSON-stringifies the value.

Parameters

NameDescription
valueAny JavaScript value.

returnsstring — - JSON string of the value.

compileCreateTable

Compiles a create-collection operation for MongoDB. Note: MongoDB creates collections implicitly on insert, but explicit creation can include options like validator.

Parameters

NameDescription
definitionTableDefinition with collection name and options.

returnsstring — - Directive string for creating a collection.

compileAlterTable

Compiles an alter-collection operation for MongoDB. Supports limited alterations like updating validation rules.

Parameters

NameDescription
definitionTableDefinition with new validation rules.

returnsstring — - Directive string for modifying collection.

compileTableExists

Compiles a check for collection existence.

Parameters

NameDescription
tableCollection name to check.

returnsstring — - Directive string for listing collections.

compileColumnExists

Compiles a check for field existence in a collection. Note: MongoDB requires sampling or schema overview.

Parameters

NameDescription
tableCollection name.
columnField name to check.

returnsstring — - Directive string for field existence check.

rename

Compiles a rename-collection operation.

Parameters

NameDescription
fromCurrent collection name.
toNew collection name.

Released under the MIT License.