Query builder improvements #128

jmikola · 2013-08-13T21:44:36Z

No description provided.

The Query object is immutable, so this shouldn't make a difference in practice.

This will require changes to ODM, as several of its tests expect this to access only $query['query'] contents.

Note: $pullAll only supports an array of values (no expressions), so it remains as-is.

The recursive merging in addManyToSet() dates back to: doctrine/mongodb-odm@59a2da0. This could be problematic if addManyToSet() was called multiple times with deep array values, as they could be merged together in PHP. The new behavior will just overwrite the existing value in $newObj, like other update operators.

MongoDB 2.4 deprecates the $pushAll operator in favor of $push with $each. Additionally, it adds support for $slice and $sort (only in combination with $each).

If the $each operator does not appear first, the $push argument will be considered a single value to append to the array field.

This changes the public API for in/notIn and removes the array cast in notIn (behavior change); however, the methods are now consistent. Other methods that take a single scalar type can use casting to sanitize their input.

geoNear commands against 2dsphere indexes require the "spherical" option to be true, so we can infer its default based on whether or not the "near" option is GeoJSON (in both Builder and Collection).

This makes map() as functional as mapReduce(), apart from setting the "reduce" option.

jwage · 2013-08-15T02:44:30Z

👍

These are not accessed in Query unless the query type is appropriate, and the initializer methods for those query types already create the expected fields.

Also renamed the option, which is set in the query array.

Builder now initializes a much smaller array, which only contains the default type. The array structure will grow as methods are called. In turn, Query only expects the "type", "query", and possibly "newObj" fields to exist. All others are checked for existence before access. geoNear options were moved into an "options" array, which is now consistent with mapReduce and group. A subtle behavioral change is that defaults for update operations and cursor options will no longer be applied unless explicitly set by the user. This should not be a problem, as the Builder defaults were consistent with those in the driver itself.

Builder::hint() is only useful for setting a cursor hint (not related to ODM's UnitOfWork hints), so there is no reason to track multiple calls and apply them all to the cursor in Query::prepareCursor().

This is consistent with what is already done for geoNear commands.

This can be removed in 2.0. It's currently a bit clumsy as the names for some of these types are arbitrary. It would be preferable to use constants.

Changed to avoid calling execute() and throw BadMethodCallException immediately if the query type is not documented as returning an Iterator. If the query type should return an Iterator, we execute it and then throw UnexpectedValueException if it does not.

jmikola added 2 commits August 13, 2013 16:30

Query::execute() should use a copy of the $options property

0964c90

The Query object is immutable, so this shouldn't make a difference in practice.

Refactor Builder::sort() to not use recursion

2e266d8

This was referenced Aug 14, 2013

Map $sort fieldnames used with $push $each doctrine/mongodb-odm#660

Open

Support limit/skip for $slice operator #129

Closed

jmikola added 18 commits August 14, 2013 14:58

Do not filter out falsey values in Query/Builder debug() methods

d6ec8e9

Query::debug() should access the entire $query property

1ea8ddc

This will require changes to ODM, as several of its tests expect this to access only $query['query'] contents.

Support values and expressions for $pull in query builder

1685790

Note: $pullAll only supports an array of values (no expressions), so it remains as-is.

Rename argument for Expr pullAll/pushAll methods

0d10218

Implement Expr::each() and allow it to be used with addToSet()

c159d27

Deprecate Expr::addManyToSet() in favor of addToSet() and each()

5999f15

Support $each/$slice/$sort operators with push()

0d88e84

MongoDB 2.4 deprecates the $pushAll operator in favor of $push with $each. Additionally, it adds support for $slice and $sort (only in combination with $each).

Expr::push() should ensure $each operator appears first

ac04fff

If the $each operator does not appear first, the $push argument will be considered a single value to append to the array field.

Test array/Expr arguments for logical operators and elemMatch

975b247

Use casting and array type-hinting for method args

8207985

This changes the public API for in/notIn and removes the array cast in notIn (behavior change); however, the methods are now consistent. Other methods that take a single scalar type can use casting to sanitize their input.

Formatting Builder method docs

4ee53d6

Expr::where() need not alter the current field

a512d7f

Builder mapReduceOptions/out methods should require mapReduce command

de44c42

Support GeoJSON in Builder::geoNear() and set spherical default

08ade88

geoNear commands against 2dsphere indexes require the "spherical" option to be true, so we can infer its default based on whether or not the "near" option is GeoJSON (in both Builder and Collection).

Make query type equality checks consistent

5a31a2b

Builder::map() should init full query array, default to inline output

16a92eb

This makes map() as functional as mapReduce(), apart from setting the "reduce" option.

Refactor Builder/Expr set() and add tests

a7ba5c2

jmikola added 7 commits August 15, 2013 14:09

Remove optional fields from Builder::$query array

e6dfbc3

These are not accessed in Query unless the query type is appropriate, and the initializer methods for those query types already create the expected fields.

Fix preparation of group "cond" option in Query::execute()

66e0355

Rename Query::DISTINCT_FIELD to DISTINCT

fe4b3ca

Also renamed the option, which is set in the query array.

Throw exception for invalid query types in Query constructor

93d9a99

Query should allow a single cursor hint to be specified

7735482

Builder::hint() is only useful for setting a cursor hint (not related to ODM's UnitOfWork hints), so there is no reason to track multiple calls and apply them all to the cursor in Query::prepareCursor().

Query should apply "limit" option for mapReduce commands

a040ddf

This is consistent with what is already done for geoNear commands.

jmikola added 7 commits August 30, 2013 16:17

Fix Collection::count() return type documentation

ee0f3c3

Add docblocks to Expr methods (mostly copied from Builder)

7cc7c5e

Add array type-hint to Builder and Expr::all()

9e117fe

Don't document string argument for Builder and Expr::type()

7f67505

This can be removed in 2.0. It's currently a bit clumsy as the names for some of these types are arbitrary. It would be preferable to use constants.

Deprecate Query::iterate() alias in favor of getIterator()

b926926

Update references to IteratorAggregate interface methods in Query

d13aab0

jmikola added a commit that referenced this pull request Sep 2, 2013

Merge pull request #128

97b70b4

jmikola merged commit d13aab0 into master Sep 2, 2013

jmikola deleted the query-builder branch September 2, 2013 18:15

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Query builder improvements #128

Query builder improvements #128

jmikola commented Aug 13, 2013

jwage commented Aug 15, 2013

Query builder improvements #128

Query builder improvements #128

Conversation

jmikola commented Aug 13, 2013

jwage commented Aug 15, 2013