Skip to content

Commit 1662f5e

Browse files
committed
Add docstring to batch creation method
1 parent 12b9f37 commit 1662f5e

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

infrahub_sdk/client.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1953,6 +1953,11 @@ def get(
19531953
return results[0]
19541954

19551955
def create_batch(self, return_exceptions: bool = False) -> InfrahubBatchSync:
1956+
"""Create a batch to execute multiple queries concurrently.
1957+
1958+
Executing the batch will be performed using a thread pool, meaning it cannot guarantee the execution order. It is not recommended to use such
1959+
batch to manipulate objects that depend on each others.
1960+
"""
19561961
return InfrahubBatchSync(
19571962
max_concurrent_execution=self.max_concurrent_execution, return_exceptions=return_exceptions
19581963
)

0 commit comments

Comments
 (0)