Skip to content

Commit 9b44b1d

Browse files
author
Sam Kleinman
committed
DOCS-1449 collection method shell tables.
1 parent 8dd0a58 commit 9b44b1d

File tree

1 file changed

+116
-0
lines changed

1 file changed

+116
-0
lines changed
Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
name: ":method:`db.collection.aggregate()`"
2+
file: /reference/method/db.collection.aggregate()
3+
description: "Provides access to the :doc:`aggregation framework </core/aggregation>` :term:`pipeline`"
4+
---
5+
name: ":method:`db.collection.count()`"
6+
file: /reference/method/db.collection.count
7+
description: "Wraps :dbcommand:`count` to return a count of the number of documents in a collection or matching a query."
8+
---
9+
name: ":method:`db.collection.createIndex()`"
10+
file: /reference/method/db.collection.createIndex
11+
description: "Builds an index on a collection. Use :method:`db.collection.ensureIndex()`."
12+
---
13+
name: ":method:`db.collection.dataSize()`"
14+
file: /reference/method/db.collection.dataSize
15+
description: "Returns the size of the collection. Wraps the :data:`~collStats.size` field in the output of the :dbcommand:`collStats`."
16+
---
17+
name: ":method:`db.collection.distinct()`"
18+
file: /reference/method/db.collection.distinct
19+
description: "Returns an array of documents that have distinct values for the specified field."
20+
---
21+
name: ":method:`db.collection.drop()`"
22+
file: /reference/method/db.collection.drop
23+
description: "Removes the specified collection from the database."
24+
---
25+
name: ":method:`db.collection.dropIndex()`"
26+
file: /reference/method/db.collection.dropIndexes
27+
description: "Removes a specified index on a collection."
28+
---
29+
name: ":method:`db.collection.dropIndexes()`"
30+
file: /reference/method/db.collection.dropIndexes
31+
description: "Removes all indexes on a collection."
32+
---
33+
name: ":method:`db.collection.ensureIndex`"
34+
file: /reference/method/db.collection.ensureIndex
35+
description: "Creates an index if it does not currently exist. If the index exists :method:`~db.collection.ensureIndex()` does nothing."
36+
---
37+
name: ":method:`db.collection.find()`"
38+
file: /reference/method/db.collection.find
39+
description: "Performs a query on a collection and returns a cursor object."
40+
---
41+
name: ":method:`db.collection.findAndModify()`"
42+
file: /reference/method/db.collection.findAndModify
43+
description: "Atomically modifies and returns a single document."
44+
---
45+
name: ":method:`db.collection.findOne()`"
46+
file: /reference/method/db.collection.findOne
47+
description: "Performs a query and returns a single document."
48+
---
49+
name: ":method:`db.collection.getIndexes()`"
50+
file: /reference/method/db.collection.getIndexes
51+
description: "Returns an array of documents that describe the existing indexes on a collection."
52+
---
53+
name: ":method:`db.collection.getShardDistribution()`"
54+
file: /reference/method/db.collection.getShardDistribution
55+
description: "For collections in sharded clusters, :method:`db.collection.getShardDistribution()` reports data of :term:`chunk` distribution."
56+
---
57+
name: ":method:`db.collection.getShardVersion()`"
58+
file: /reference/method/db.collection.getShardVersion()
59+
description: "Internal diagnostic method for shard cluster."
60+
---
61+
name: ":method:`db.collection.group()`"
62+
file: /reference/method/db.collection.group
63+
description: "Provides simple data aggregation function. Groups documents in a collection by a key, and processes the results. Use :method:`~db.collection.aggregate()` for more complex data aggregation."
64+
---
65+
name: ":method:`db.collection.insert()`"
66+
file: /reference/method/db.collection.insert
67+
description: "Creates a new document in a collection."
68+
---
69+
name: ":method:`db.collection.isCapped()`"
70+
file: /reference/method/db.collection.isCapped
71+
description: "Reports if a collection is a :term:`capped collection`."
72+
---
73+
name: ":method:`db.collection.mapReduce()`"
74+
file: /reference/method/db.collection.mapReduce
75+
description: "Performs map-reduce style data aggregation."
76+
---
77+
name: ":method:`db.collection.reIndex()`"
78+
file: /reference/method/db.collection.reIndex
79+
description: "Rebuilds all existing indexes on a collection."
80+
---
81+
name: ":method:`db.collection.remove()`"
82+
file: /reference/method/db.collection.remove
83+
description: "Deletes documents from a collection."
84+
---
85+
name: ":method:`db.collection.renameCollection()`"
86+
file: /reference/method/db.collection.renameCollection
87+
description: "Changes the name of a collection."
88+
---
89+
name: ":method:`db.collection.save()`"
90+
file: /reference/method/db.collection.save
91+
description: "Provides a wrapper around an :method:`~db.collection.insert()` and :method:`~db.collection.update()` to insert new documents."
92+
---
93+
name: ":method:`db.collection.stats()`"
94+
file: /reference/method/db.collection.stats
95+
description: "Reports on the state of a collection. Provides a wrapper around the :dbcommand:`collStats`."
96+
---
97+
name: ":method:`db.collection.storageSize()`"
98+
file: /reference/method/db.collection.storageSize
99+
description: "Reports the total size used by the collection. Provides a wrapper around the :data:`~collStats.storageSize` field of the :dbcommand:`collStats` output."
100+
---
101+
name: ":method:`db.collection.totalSize()`"
102+
file: /reference/method/db.collection.toalSize
103+
description: "Reports the total size of a collection, including the size of all documents and all indexes on a collection."
104+
---
105+
name: ":method:`db.collection.storageSize()`"
106+
file: /reference/method/db.collection.storageSize
107+
description: "Reports the total size used by the indexes on a collection. Provides a wrapper around the :data:`~collStats.totalIndexSize` field of the :dbcommand:`collStats` output."
108+
---
109+
name: ":method:`db.collection.update()`"
110+
file: /reference/method/db.collection.update
111+
description: "Modifies a document in a collection."
112+
---
113+
name: ":method:`db.collection.validate()`"
114+
file: /reference/method/db.collection.validate
115+
description: "Performs diagnostic operations on a collection."
116+
...

0 commit comments

Comments
 (0)