Commit 98474c3

authored

DOCSP-43530: Id field in query results (#3149)

Adds information about ID field representation in query builder results

1 parent cf9c9b1 commit 98474c3Copy full SHA for 98474c3

File tree

-6

lines changed

-6

lines changed

Lines changed: 4 additions & 3 deletions

Original file line number	Diff line number	Diff line change
@@ -195,9 +195,10 @@ the value of the ``title`` field is ``"Back to the Future"``:
`195`	`195`
`196`	`196`	You can use the ``id`` alias in your queries to represent the
`197`	`197`	``_id`` field in MongoDB documents, as shown in the preceding
`198`		`- code. When you run a find operation using the query builder, {+odm-short+}`
`199`		- automatically converts between ``id`` and ``_id``. This provides better
`200`		`- compatibility with Laravel, as the framework assumes that each record has a`
	`198`	`+ code. When you use the query builder to run a find operation, the {+odm-short+}`
	`199`	+ automatically converts between ``_id`` and ``id`` field names. In query results,
	`200`	+ the ``_id`` field is presented as ``id``. This provides better
	`201`	`+ consistency with Laravel, as the framework assumes that each record has a`
`201`	`202`	primary key named ``id`` by default.
`202`	`203`
`203`	`204`	Because of this behavior, you cannot have two separate ``id`` and ``_id``

Lines changed: 4 additions & 3 deletions

Original file line number	Diff line number	Diff line change
`@@ -115,9 +115,10 @@ This library version introduces the following breaking changes:`
`115`	`115`	`date classes, applying the default timezone.`
`116`	`116`
`117`	`117`	- ``id`` is an alias for the ``_id`` field in MongoDB documents, and the library
`118`		- automatically converts between ``id`` and ``_id`` when querying data. Because
`119`		- of this behavior, you cannot have two separate ``id`` and ``_id`` fields in your
`120`		`- documents.`
	`118`	+ automatically converts between ``id`` and ``_id`` when querying data. The query
	`119`	+ result object includes an ``id`` field to represent the document's ``_id`` field.
	`120`	+ Because of this behavior, you cannot have two separate ``id`` and ``_id`` fields
	`121`	`+ in your documents.`
`121`	`122`
`122`	`123`	- Removes support for the ``$collection`` property. The following code shows
`123`	`124`	how to assign a MongoDB collection to a variable in your ``User`` class in

Comments

(0)