Bastien Gérard
be2c4f2b3c
fix formatting and improve doc based on review
2019-09-16 21:15:35 +02:00
Bastien Gérard
7ac74b1c1f
Document Model.objects.aggregate entrypoint with an example
2019-09-15 23:27:34 +02:00
Stefan Wójcik
ae0384df29
Improve Document.meta.shard_key docs ( #2099 )
...
This closes #2096 . Previous documentation of the shard_key meta attribute was
missing the crucial point that it really only matters if your collection is
sharded over a compound index.
2019-06-20 11:25:51 +02:00
Bastien Gérard
70d6e763b0
Document the custom field validation feature
2019-06-05 22:23:54 +02:00
Bastien Gérard
5bf1dd55b1
Update mongomock example
...
Improved the mongomock example as reported in #2067
Fixes #2067
2019-06-04 22:56:52 +02:00
Bastien Gérard
048a045966
Update connection/multiple databases docs
...
I observed that many people were confused by this so I thought I'd make the multiple databases example more explicit
2019-06-04 21:47:28 +02:00
Bastien Gérard
b1e28d02f7
Improve connect/disconnect
...
- document disconnect + sample of usage
- add more test cases to prevent github issues regressions
2019-04-24 22:44:07 +02:00
lalala223
48b849c031
Update querying.rst
...
Fix the 'not' operator error example.
2019-03-13 17:50:54 +08:00
G Roques
e7000db491
Add LongField to Fields list
2018-12-29 13:08:39 -06:00
amir-almusawi
48a691e722
fixed small typographical error
2018-12-07 22:08:05 -06:00
erdenezul
18b47e4a73
Merge pull request #1932 from bagerard/improve_index_doc
...
minor improvement to index doc
2018-10-25 10:19:04 +08:00
Bastien Gérard
c685ace327
minor improvement to index doc
2018-10-23 23:55:55 +02:00
Bastien Gérard
f23b0faf41
fix some asserts in no_dereference doc
2018-10-23 22:10:34 +02:00
Bastien Gérard
83fe7f7eef
Document the index option and the fact that additional options gets forwarded to pymongo's create_index method
2018-10-22 21:54:46 +02:00
Bastien Gérard
d6e39b362b
Updating inheritance doc
...
Fixes #429
2018-09-09 14:52:08 +02:00
Bastien Gérard
a86092fb64
fix doc for meta index_options
2018-09-06 22:33:33 +02:00
erdenezul
5a091956ef
Merge pull request #1862 from bagerard/document_name_param_for_indexes
...
Documented that it is possible to specify a 'name' for the indexes (using the dict definition)
2018-09-03 17:20:17 +08:00
Bastien Gérard
a3bcf26dce
Merge branch 'master' of https://github.com/MongoEngine/mongoengine into pmatos_patch-1
2018-09-02 15:27:37 +02:00
Bastien Gérard
bd524d2e1e
Documented that it is possible to specify a name when using a dict to define an index
2018-09-01 00:12:49 +02:00
Bastien Gérard
461b789515
relates to ( #710 )
...
- Update gridfs.rst to make it clearer that you should save the Document hosting the GridFSProxy after calling .delete() or .replace() on the GridFSProxy
- updated GridFSProxy.__str__ so that it would always print both the filename and the grid_id. This should improve debugging
2018-08-19 23:45:08 +02:00
Bastien Gérard
1a2b1f283b
Update signals doc - clarification on EmbeddedDocument
...
Since there is a .save() method on EmbeddedDocument, you could be tempted to attach a pre_save event to an EmbeddedDocument (#1720 ). This update is an attempt to make this clearer.
2018-08-13 22:16:32 +02:00
JoschSan
820f7b4d93
Update connecting.rst
...
My suggest is append the parameter in authentication_source in authentication example, because was included in https://github.com/MongoEngine/mongoengine/pull/590/files
2018-08-07 14:29:15 -04:00
erdenezul
765038274c
Merge pull request #1691 from rcscott/document-auto-create-index
...
Add documentation for auto_create_index to the Indexing section of the Docs
2018-05-21 08:55:25 +08:00
Emmanuel Nosa Evbuomwan
faca8512c5
Updated text-indexes.rst
...
The search statement under the `Ordering by text score` section uses `search` on the QuerySet object instead of `search_text` and thus raised an `AttributeError`
AttributeError: 'QuerySet' object has no attribute 'search'
2018-04-29 17:32:03 +01:00
Benjamin Chrobot
49bff5d544
Add documentation for LazyReference and GenericLazyReference fields.
2018-04-12 10:47:52 -04:00
estein-de
aa68322641
MongoDB wants dates stored in UTC, but the functions used in this documentation to generate datetime objects would use server's local timezone - fix it! ( #1662 )
2018-02-27 09:43:09 -05:00
Esmail
fdda27abd1
Update post_save
signal documentation to reflect #594
2018-02-01 12:58:10 -05:00
Ryan Scott
4f5b0634ad
Add documentation for auto_create_index to the Indexing section of the Docs
2017-11-07 16:26:01 -05:00
Paulo Matos
c4de879b20
Clarify comment in validation example
2017-08-11 09:09:33 +02:00
Erdenezul Batmunkh
fb00b79d19
add docs for positional push operator #1565
2017-06-19 03:28:34 +00:00
Stefan Wojcik
19ef2be88b
fix #937
2017-03-05 00:05:33 -05:00
Stefan Wójcik
5f43c032f2
revamp the "connecting" user guide and test more ways of connecting to a replica set ( #1490 )
2017-02-26 21:29:06 -05:00
bagerard
b27c7ce11b
allow to use sets in field choices ( #1482 )
2017-02-15 08:51:47 -05:00
martin sereinig
d8a7328365
Fix docs regarding reverse_delete_rule and delete signals ( #1473 )
2017-02-06 14:11:42 -07:00
Stefan Wojcik
47c58bce2b
fix "connect" example in the docs
2016-12-28 21:08:18 -05:00
George Karakostas
c84f703f92
Update documentation to include a Q import ( #1441 )
2016-12-22 13:06:55 -05:00
BenCotte
d8dd07d9ef
Updating Dict Fields use description
...
Update dict fields use misleading description to clarify use case.
2016-11-20 11:22:34 +01:00
BenCotte
43dabb2825
Dictionnary Field recommended use
...
At Dictionary Fields description, it seems that the intent of the sentence make more sense by adding : "not".
2016-10-11 18:14:17 +02:00
Gallaecio
8f55d385d6
Fix array-slicing documentation
...
Fixes #1359 .
2016-08-11 08:52:53 +02:00
DionysusG
709983eea6
fix typo at docs/guide/defineing-documents.rst
2016-08-04 16:21:52 +08:00
Omer Katz
815b2be7f7
Merge pull request #1183 from bitdivision/patch-1
...
Add EmbeddedDocumentListField to user guide
2016-02-24 09:01:54 +02:00
Ruslan Nassonov
3d80e549cb
fix missing quote in /docs/guide/mongomock.rst
2015-12-25 15:52:35 +05:00
bitdivision
9c264611cf
Add EmbeddedDocumentListField to user guide
...
The 'defining a document' section currently doesn't include EmbeddedDocumentListField. Only EmbeddedDocumentField
2015-12-09 11:40:22 +00:00
moonso
a3886702a3
Added page for documenting mongomock. Updated docs/guide/index.rst
2015-12-06 11:02:26 +01:00
Alice Bevan–McGregor
50b271c868
Arbitrary metadata documentation.
2015-10-13 22:51:03 -04:00
Emmanuel Leblond
33b4d83c73
Merge pull request #1084 from optik/patch-1
...
Bad property name for text search index meta
2015-09-02 18:27:10 +02:00
marcoskv
a70ef5594d
QuerySet count vs len #937
...
Current documentation does not consider performance issues in using len instead of count.
https://github.com/MongoEngine/mongoengine/issues/937
2015-07-26 22:41:24 +02:00
optik
6d991586fd
Bad property name for indices description in docs
...
The correct name for MongoDB index definition property is weights not weight. Using "weight" will cause "Index with name ... already exists with different options"
2015-07-24 15:26:10 +02:00
Matthieu Rigal
0aeb1ca408
Various fixes again
2015-06-24 00:50:36 +02:00
Matthieu Rigal
5efabdcea3
Added tests, documentation and simplified code
2015-06-22 14:57:58 +02:00