Skip to content

Commit 78db628

Browse files
committed
Remove references to RocksDB in docstrings
No reason to specifically mention the only possible engine.
1 parent c1f341a commit 78db628

File tree

4 files changed

+11
-20
lines changed

4 files changed

+11
-20
lines changed

arango/aql.py

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -183,18 +183,15 @@ def execute(self,
183183
:param profile: Return additional profiling details in the cursor,
184184
unless the query cache is used.
185185
:type profile: bool
186-
:param max_transaction_size: Transaction size limit in bytes. Applies
187-
only to RocksDB storage engine.
186+
:param max_transaction_size: Transaction size limit in bytes.
188187
:type max_transaction_size: int
189188
:param max_warning_count: Max number of warnings returned.
190189
:type max_warning_count: int
191190
:param intermediate_commit_count: Max number of operations after
192-
which an intermediate commit is performed automatically. Applies
193-
only to RocksDB storage engine.
191+
which an intermediate commit is performed automatically.
194192
:type intermediate_commit_count: int
195193
:param intermediate_commit_size: Max size of operations in bytes after
196-
which an intermediate commit is performed automatically. Applies
197-
only to RocksDB storage engine.
194+
which an intermediate commit is performed automatically.
198195
:type intermediate_commit_size: int
199196
:param satellite_sync_wait: Number of seconds in which the server must
200197
synchronize the satellite collections involved in the query. When

arango/database.py

Lines changed: 5 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -238,20 +238,17 @@ def execute_transaction(self,
238238
ArangoDB server waits indefinitely. If not set, system default
239239
value is used.
240240
:type timeout: int
241-
:param max_size: Max transaction size limit in bytes. Applies only
242-
to RocksDB storage engine.
241+
:param max_size: Max transaction size limit in bytes.
243242
:type max_size: int
244243
:param allow_implicit: If set to True, undeclared read collections are
245244
loaded lazily. If set to False, transaction fails on any undeclared
246245
collections.
247246
:type allow_implicit: bool
248247
:param intermediate_commit_count: Max number of operations after which
249-
an intermediate commit is performed automatically. Applies only to
250-
RocksDB storage engine.
248+
an intermediate commit is performed automatically.
251249
:type intermediate_commit_count: int
252250
:param intermediate_commit_size: Max size of operations in bytes after
253-
which an intermediate commit is performed automatically. Applies
254-
only to RocksDB storage engine.
251+
which an intermediate commit is performed automatically.
255252
:type intermediate_commit_size: int
256253
:return: Return value of **command**.
257254
:rtype: str | unicode
@@ -2490,8 +2487,7 @@ def begin_transaction(self,
24902487
given, a default value is used. Setting it to 0 disables the
24912488
timeout.
24922489
:type lock_timeout: int
2493-
:param max_size: Max transaction size in bytes. Applicable to RocksDB
2494-
storage engine only.
2490+
:param max_size: Max transaction size in bytes.
24952491
:type max_size:
24962492
:return: Database API wrapper object specifically for transactions.
24972493
:rtype: arango.database.TransactionDatabase
@@ -2612,8 +2608,7 @@ class TransactionDatabase(Database):
26122608
:param lock_timeout: Timeout for waiting on collection locks. If not given,
26132609
a default value is used. Setting it to 0 disables the timeout.
26142610
:type lock_timeout: int
2615-
:param max_size: Max transaction size in bytes. Applicable to RocksDB
2616-
storage engine only.
2611+
:param max_size: Max transaction size in bytes.
26172612
:type max_size: int
26182613
"""
26192614

arango/executor.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -302,8 +302,7 @@ class TransactionExecutor(Executor):
302302
:param lock_timeout: Timeout for waiting on collection locks. If not given,
303303
a default value is used. Setting it to 0 disables the timeout.
304304
:type lock_timeout: int
305-
:param max_size: Max transaction size in bytes. Applicable to RocksDB
306-
storage engine only.
305+
:param max_size: Max transaction size in bytes.
307306
:type max_size: int
308307
"""
309308
context = 'transaction'

arango/replication.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ def __init__(self, connection, executor):
4040
def inventory(self, batch_id, include_system=None, all_databases=None):
4141
"""Return an overview of collections and indexes.
4242
43-
:param batch_id: Batch ID. For RocksDB engine only.
43+
:param batch_id: Batch ID.
4444
:type batch_id: str | unicode
4545
:param include_system: Include system collections in the result.
4646
Default value is True.
@@ -158,7 +158,7 @@ def dump(self,
158158
:param chunk_size: Size of the result in bytes. This value is honored
159159
approximately only.
160160
:type chunk_size: int
161-
:param batch_id: Batch ID. For RocksDB engine only.
161+
:param batch_id: Batch ID.
162162
:type batch_id: str | unicode
163163
:param deserialize: Deserialize the response content. Default is False.
164164
:type deserialize: bool

0 commit comments

Comments
 (0)