diff options
Diffstat (limited to 'src/mongo/db/generic_cursor.idl')
| -rw-r--r-- | src/mongo/db/generic_cursor.idl | 43 |
1 files changed, 30 insertions, 13 deletions
diff --git a/src/mongo/db/generic_cursor.idl b/src/mongo/db/generic_cursor.idl index 2792a9db88e..b3ac144baf9 100644 --- a/src/mongo/db/generic_cursor.idl +++ b/src/mongo/db/generic_cursor.idl @@ -1,16 +1,33 @@ # Copyright (C) 2017 MongoDB Inc. # # This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU Affero General Public License, version 3, -# as published by the Free Software Foundation. + +# 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. # -# 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 -# GNU Affero General 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>. # -# You should have received a copy of the GNU Affero General Public License -# along with this program. If not, see <http://www.gnu.org/licenses/>. +# 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 @@ -33,7 +50,7 @@ structs: type: long optional: true ns: - description: The namespace of the cursor. + description: The namespace of the cursor. type: namespacestring optional: true createdDate: @@ -53,15 +70,15 @@ structs: type: long optional: true noCursorTimeout: - description: If true the cursor will not be timed out because of inactivity. + description: If true the cursor will not be timed out because of inactivity. type: bool optional: true - tailable: + 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. + 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: @@ -71,7 +88,7 @@ structs: lsid: type: LogicalSessionId optional: true - planSummary: + planSummary: description: The plan summary of this cursor's query. type: string optional: true |