Add bulk_insert option to add list of records using auditor client and pyauditor #582
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #582 +/- ##
==========================================
+ Coverage 64.06% 64.47% +0.41%
==========================================
Files 46 46
Lines 5387 5531 +144
Branches 58 58
==========================================
+ Hits 3451 3566 +115
- Misses 1936 1965 +29
|
raghuvar-vijay
force-pushed
the
bulk-insert
branch
from
74ad7ac to
1598419
Compare
QuantumDancer
suggested changes
Dec 7, 2023
auditor/src/lib.rs
Outdated
Comment on lines
115
to
118
| //! # let records: Result<Vec<RecordAdd>, _> = (0..5) | ||
| //! # .map(|i| RecordAdd::new(&format!("record-{}", i), HashMap::new(), vec![], start_time)) | ||
| //! # .collect(); | ||
| //! client.bulk_insert(&records?).await?; |
There was a problem hiding this comment.
Can records be of type Vec<RecordAdd> so that we then have client.bulk_insert(&records).await?; inside the docs?
auditor/src/routes/add.rs
Outdated
Comment on lines
185
to
186
| #[tracing::instrument(name = "Adding a record to the database", skip(records, pool))] | ||
| pub async fn bulk_add( |
There was a problem hiding this comment.
The tracing instrument name doesn't match what the function is doing. Maybe switch to "Adding multiple records to the database" or something like this.
pyauditor/docs/examples.rst
Outdated
| @@ -98,6 +98,14 @@ Assuming that a record and a client were already created, the record can be push | |||
|
|
|||
| await client.add(record) | |||
|
|
|||
| Pushing list of records to Auditor | |||
There was a problem hiding this comment.
Pushing list -> Pushing a list
pyauditor/src/blocking_client.rs
Outdated
| @@ -121,6 +121,19 @@ impl AuditorClientBlocking { | |||
| .map_err(|e| pyo3::exceptions::PyRuntimeError::new_err(format!("{e}"))) | |||
| } | |||
|
|
|||
| /// add(record: Record) | |||
| /// Push a record to the Auditor instance | |||
There was a problem hiding this comment.
Same as above (a record != bulk_insert)
pyauditor/src/client.rs
Outdated
| @@ -797,6 +797,25 @@ impl AuditorClient { | |||
| }) | |||
| } | |||
|
|
|||
| /// add(record: Record) | |||
| /// Push a record to the Auditor instance | |||
raghuvar-vijay
force-pushed
the
bulk-insert
branch
2 times, most recently
from
57431ca to
06ebd00
Compare
QuantumDancer
approved these changes
Dec 7, 2023
raghuvar-vijay
force-pushed
the
bulk-insert
branch
from
06ebd00 to
980b0ef
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This closes #580
Bulk insertion of records is implemented for auditor. This allows list of records to be passed as an argument to auditor client and pyauditor methods.
Added unit test, API tests for auditor and pyauditor client.
Created new end point called /records - this will be used to perform bulk operations (in the future, this can be extended to update as well using PUT method)
Written doc strings and tutorial to use bulk_insert functionality.
Added CHANGELOG.md