Bulk Class Reference

Public Member Functions
def	__init__ (self, Client c)
def	__enter__ (self)
def	__exit__ (self, exc_type, exc_val, exc_tb)
Result	browse (self, typing.List[str] request, ResponseCallback cb=None, userData_c_void_p userdata=None)
def	close (self)
Result	create (self, typing.List[BulkCreateRequest] request, ResponseCallback cb=None, userData_c_void_p userdata=None)
Result	delete (self, typing.List[str] request, ResponseCallback cb=None, userData_c_void_p userdata=None)
typing.List[Response]	get_response (self)
Result	metadata (self, typing.List[str] request, ResponseCallback cb=None, userData_c_void_p userdata=None)
Result	read (self, typing.List[BulkReadRequest] request, ResponseCallback cb=None, userData_c_void_p userdata=None)
Result	write (self, typing.List[BulkWriteRequest] request, ResponseCallback cb=None, userData_c_void_p userdata=None)

Detailed Description

class Bulk

Definition at line 574 of file bulk.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
		Client	c
	)

init

Parameters

c

Client

Definition at line 582 of file bulk.py.

References Bulk.__on_cb, SubscriptionAsync.__on_cb, Bulk.__ptr_resp, SubscriptionAsync.__ptr_resp, Bulk.__resp_mgr, Bulk._client, and Bulk._requests.

Member Function Documentation

browse()

Result browse	(		self,
		typing.List[str]	request,
		ResponseCallback	cb = None,
		userData_c_void_p	userdata = None
	)

browse

   Bulk browse request to browse multiple nodes with a single request
   With cb is None, browse is called synchronously

Parameters

request	list of requests cb (ResponseCallback, optional): callback Callback to call when function is finished. Defaults to None.
userdata	User data - will be returned in callback as userdata. You can use this userdata to identify your request

Returns

Result status of function call

Definition at line 791 of file bulk.py.

References Bulk.__close_mgr(), SubscriptionAsync.__create_response_callback(), Bulk.__create_response_callback(), Bulk.__resp_mgr, Bulk._add(), Bulk._browse_async(), Bulk._browse_sync(), Bulk._client, and Bulk._requests.

create()

Result create	(		self,
		typing.List[BulkCreateRequest]	request,
		ResponseCallback	cb = None,
		userData_c_void_p	userdata = None
	)

create

   Bulk create request to create multiple nodes with a single request
   With cb is None, create is called synchronously

Parameters

request	list of requests cb (ResponseCallback, optional): callback Callback to call when function is finished. Defaults to None.
userdata	User data - will be returned in callback as userdata. You can use this userdata to identify your request

Returns

Result status of function call

Definition at line 907 of file bulk.py.

References Bulk.__close_mgr(), SubscriptionAsync.__create_response_callback(), Bulk.__create_response_callback(), Bulk.__resp_mgr, Bulk._add(), Bulk._client, Bulk._create_async(), Bulk._create_sync(), and Bulk._requests.

delete()

Result delete	(		self,
		typing.List[str]	request,
		ResponseCallback	cb = None,
		userData_c_void_p	userdata = None
	)

delete

   Bulk delete request to delete multiple nodes with a single request
   With cb is None, delete is called synchronously

Parameters

request	list of requests cb (ResponseCallback, optional): callback Callback to call when function is finished. Defaults to None.
userdata	User data - will be returned in callback as userdata. You can use this userdata to identify your request

Returns

Result status of function call

Definition at line 964 of file bulk.py.

References Bulk.__close_mgr(), SubscriptionAsync.__create_response_callback(), Bulk.__create_response_callback(), Bulk.__resp_mgr, Bulk._add(), Bulk._client, Bulk._delete_async(), Bulk._delete_sync(), and Bulk._requests.

get_response()

typing.List[Response] get_response

(

self

)

get_response

Returns

typing List of response

Definition at line 1013 of file bulk.py.

References Bulk.__resp_mgr, and Bulk.close().

metadata()

Result metadata	(		self,
		typing.List[str]	request,
		ResponseCallback	cb = None,
		userData_c_void_p	userdata = None
	)

metadata

   Bulk metadata request to metadata multiple nodes with a single request
   With cb is None, metadata is called synchronously

Parameters

request	list of requests cb (ResponseCallback, optional): callback Callback to call when function is finished. Defaults to None.
userdata	User data - will be returned in callback as userdata. You can use this userdata to identify your request

Returns

Result status of function call

Definition at line 849 of file bulk.py.

References Bulk.__close_mgr(), SubscriptionAsync.__create_response_callback(), Bulk.__create_response_callback(), Bulk.__resp_mgr, Bulk._add(), Bulk._client, Bulk._metadata_async(), Bulk._metadata_sync(), and Bulk._requests.

read()

Result read	(		self,
		typing.List[BulkReadRequest]	request,
		ResponseCallback	cb = None,
		userData_c_void_p	userdata = None
	)

read

   Bulk read request to read multiple nodes with a single request.
   With cb is None, read is called synchronously

Parameters

request	list of requests cb (ResponseCallback, optional): Callback to call when function is finished. Defaults to None.
userdata	User data - will be returned in callback as userdata. You can use this userdata to identify your request

Returns

Result status of function call

Definition at line 677 of file bulk.py.

References Bulk.__close_mgr(), SubscriptionAsync.__create_response_callback(), Bulk.__create_response_callback(), Bulk.__resp_mgr, Bulk._add(), Bulk._client, Bulk._read_async(), Bulk._read_sync(), and Bulk._requests.

write()

Result write	(		self,
		typing.List[BulkWriteRequest]	request,
		ResponseCallback	cb = None,
		userData_c_void_p	userdata = None
	)

write

   Bulk write request to write multiple nodes with a single request
   With cb is None, write is called synchronously

Parameters

request	list of requests cb (ResponseCallback, optional): callback Callback to call when function is finished. Defaults to None.
userdata	User data - will be returned in callback as userdata. You can use this userdata to identify your request

Returns

Result status of function call

Definition at line 734 of file bulk.py.

References Bulk.__close_mgr(), SubscriptionAsync.__create_response_callback(), Bulk.__create_response_callback(), Bulk.__resp_mgr, Bulk._add(), Bulk._client, Bulk._requests, Bulk._write_async(), and Bulk._write_sync().