summaryrefslogtreecommitdiff
path: root/src/mongo/s/query/async_results_merger_params.idl
diff options
context:
space:
mode:
Diffstat (limited to 'src/mongo/s/query/async_results_merger_params.idl')
-rw-r--r--src/mongo/s/query/async_results_merger_params.idl89
1 files changed, 0 insertions, 89 deletions
diff --git a/src/mongo/s/query/async_results_merger_params.idl b/src/mongo/s/query/async_results_merger_params.idl
deleted file mode 100644
index dafc9b53c1c..00000000000
--- a/src/mongo/s/query/async_results_merger_params.idl
+++ /dev/null
@@ -1,89 +0,0 @@
-# Copyright (C) 2018 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.
-#
-# 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 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 GNU Affero General 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.
-
-global:
- cpp_namespace: "mongo"
- cpp_includes:
- - "mongo/s/shard_id.h"
- - "mongo/util/net/hostandport.h"
- - "mongo/db/query/cursor_response.h"
-
-imports:
- - "mongo/db/query/tailable_mode.idl"
- - "mongo/idl/basic_types.idl"
- - "mongo/util/net/hostandport.idl"
-
-types:
- CursorResponse:
- bson_serialization_type: object
- description: The first batch returned after establishing cursors on a shard.
- cpp_type: CursorResponse
- serializer: CursorResponse::toBSONAsInitialResponse
- deserializer: CursorResponse::parseFromBSONThrowing
-
-structs:
- RemoteCursor:
- description: A description of a cursor opened on a remote server.
- fields:
- shardId:
- type: string
- description: The shardId of the shard on which the cursor resides.
- hostAndPort:
- type: HostAndPort
- description: The exact host (within the shard) on which the cursor resides.
- cursorResponse:
- type: CursorResponse
- description: The response after establishing a cursor on the remote shard, including
- the first batch.
-
- AsyncResultsMergerParams:
- description: The parameters needed to establish an AsyncResultsMerger.
- fields:
- sort:
- type: object
- description: The sort requested on the merging operation. Empty if there is no sort.
- optional: true
- compareWholeSortKey:
- type: bool
- default: false
- description: >-
- When 'compareWholeSortKey' is true, $sortKey is a scalar value, rather than an
- object. We extract the sort key {$sortKey: <value>}. The sort key pattern is
- verified to be {$sortKey: 1}.
- remotes: array<RemoteCursor>
- tailableMode:
- type: TailableMode
- optional: true
- description: If set, the tailability mode of this cursor.
- batchSize:
- type: safeInt64
- optional: true
- description: The batch size for this cursor.
- nss: namespacestring
- allowPartialResults:
- type: bool
- default: false
- description: If set, error responses are ignored.