summaryrefslogtreecommitdiff
path: root/src/mongo/db/generic_cursor.idl
blob: edb3929f6d51188700498ed8c485cd29c6f6b8f0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# Copyright (C) 2018-present MongoDB, Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the Server Side Public License, version 1,
# as published by MongoDB, Inc.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# Server Side Public License for more details.
#
# You should have received a copy of the Server Side Public License
# along with this program. If not, see
# <http://www.mongodb.com/licensing/server-side-public-license>.
#
# As a special exception, the copyright holders give permission to link the
# code of portions of this program with the OpenSSL library under certain
# conditions as described in each individual source file and distribute
# linked combinations including the program with the OpenSSL library. You
# must comply with the Server Side Public License in all respects for
# all of the code used other than as permitted herein. If you modify file(s)
# with this exception, you may extend this exception to your version of the
# file(s), but you are not obligated to do so. If you do not wish to do so,
# delete this exception statement from your version. If you delete this
# exception statement from all source files in the program, then also delete
# it in the license file.
#

# This IDL file describes the BSON format for a GenericCursor, and
# handles the serialization to and deserialization from its BSON representation
# for that class.

global:
  cpp_namespace: "mongo"

imports:
  - "mongo/db/logical_session_id.idl"
  - "mongo/idl/basic_types.idl"

structs:
  GenericCursor:
    description: "A struct representing a cursor in either mongod or mongos"
    fields:
      cursorId:
        description: The cursor id of the cursor.
        type: long
        optional: true
      ns:
        description: The namespace of the cursor.
        type: namespacestring
        optional: true
      createdDate:
        description: The time and date the cursor was created.
        type: date
        optional: true
      lastAccessDate:
        description: The last time the cursor was used (was pinned).
        type: date
        optional: true
      nDocsReturned:
        description: The number of docs returned by the cursor.
        type: long
        optional: true
      nBatchesReturned:
        description: The number of batches returned by the cursor.
        type: long
        optional: true
      noCursorTimeout:
        description: If true the cursor will not be timed out because of inactivity.
        type: bool
        optional: true
      tailable:
        description: Whether the cursor is tailable and remains open after exhausting all documents in the find.
        type: bool
        optional: true
      awaitData:
        description: Whether this is a tailable and awaitData cursor that will block waiting for new data to be inserted into a capped collection.
        type: bool
        optional: true
      originatingCommand:
        description: The bson object containing the command that created the cursor.
        type: object
        optional: true
      lsid:
        type: LogicalSessionId
        optional: true
      planSummary:
        description: The plan summary of this cursor's query.
        type: string
        optional: true
      operationUsingCursorId:
        description: The op ID of the operation pinning the cursor. Will be empty for idle cursors.
        type: long
        optional: true