Bulk Read RowsAdmin Scope
Notes:
-
Ensure you have installed the required package to use this SDK method.
-
A maximum of 200,000 rows can be read simultaneously.
You can perform bulk read jobs on row data stored in a table in Catalyst DataStore. Using the following bulk read utility, you can read thousands of records from a specific table and generate a .CSV file containing the results of read operation.
Methods Used
| Methods Used | Description |
|---|---|
| bulkRead.createJob({criteria, page,select_columns}) | Create new bulk read job. |
| bulkRead.getStatus(jobID) | Get a bulk read job status. |
| bulkRead.getResult(jobID) | Get a bulk read job's result. |
The required table is referred to by its Table ID. The datastore reference used in the following code snippet is the component instance.
Info: You can also use the dataStore.table().bulkJob(‘read’ | ‘write’) method to perform either a bulk read or a bulk write job.
copy
// Bulk read
const datastore = new Datastore(); // get datastore instance
const bulkRead = datastore.table("sampleTable").bulkJob("read");
const bulkReadJob = await bulkRead.createJob({
criteria: {
group_operator: "or",
group: [
{ column_name: "Department", comparator: "equal", value: "Marketing" },
{ column_name: "EmpID", comparator: "greater_than", value: "1000" },
{ column_name: "EmpName", comparator: "starts_with", value: "S" }
]
},
page: 1,
select_columns: ["EmpID", "EmpName", "Department"],
url: "https://hr.zylker.com/en/EmpRecords/_callback.php",
headers: { src: "ZCatalyst", operation: "bulkreadAPI" },
params: { project_name: "EmployeeDatabase" }
});Get Bulk Read Status
copy
await bulkRead.getStatus(bulkReadJob.job_id);Get Bulk Read Result
Note: The bulk read job status must be Completed for the result to be retrieved successfully.
copy
await bulkRead.getResult(bulkReadJob.job_id);Last Updated 2026-07-02 14:51:41 +0530 IST
Yes
No
Thank you for your feedback!
Send your feedback to us
Skip
Submit