Add object store #299
Open
Add object store #299
Conversation
This file contains hidden or 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
Signed-off-by: Bruno Alvisio <[email protected]>
mdemoret-nv
added
feature request
mdemoret-nv
requested changes
Jun 10, 2025
There was a problem hiding this comment.
This is a really good start. I have a few general suggestions:
- One goal of this was to allow accessing these objects from the fastapi server. I think we need to update the server configuration options to support something like this:
# Upload static files to the object store
async def static_files(file: UploadFile):
object_store_client = builder.get_object_store_client(self.front_end_config.object_store)
file_data = await file.read()
await object_store_client.put_object(file.filename, ObjectStoreItem(data=file_data, content_type=file.content_type))
return {"filename": file.filename}
app.add_api_route(
path="/static",
endpoint=static_files,
methods=["POST"],
)
# Get static files from the object store
async def get_static_files(file_name: str):
object_store_client = builder.get_object_store_client(self.front_end_config.object_store)
file_data = await object_store_client.get_object(file_name)
return FileResponse(file_data.data, media_type=file_data.content_type)
app.add_api_route(
path="/static/{file_name}",
endpoint=get_static_files,
methods=["GET"],
)- The functions in the user_report example should be generalizable and could be included in the main library since they will work with any data store.
- Are there other more complex data store types that we should consider to ensure the interface works. Redis? MySQL?
- Will need to update documentation
Comment on lines
+27
to
+31
| bucket_name: str, | ||
| access_key: str | None, | ||
| secret_key: str | None, | ||
| region: str | None, | ||
| endpoint_url: str | None): |
There was a problem hiding this comment.
If you just accept the config object directly, this simplifies the signature
| endpoint_url: str | None): | ||
| self.bucket_name = bucket_name | ||
| self.session = aioboto3.Session() | ||
| access_key = access_key or os.environ.get("OBJECT_STORE_ACCESS_KEY") |
There was a problem hiding this comment.
Prefix all env variables with AIQ_
| pass | ||
|
|
||
| @abstractmethod | ||
| async def get_object(self, key: str) -> ObjectStoreItem | str: |
There was a problem hiding this comment.
How can this return a string if you cant set a string?
| """ | ||
|
|
||
| @abstractmethod | ||
| async def put_object(self, key: str, data: ObjectStoreItem) -> None: |
There was a problem hiding this comment.
Need to address duplicate entries. Do we add an upsert method?
| pass | ||
|
|
||
| @abstractmethod | ||
| async def delete_object(self, key: str) -> None: |
There was a problem hiding this comment.
What about checking if a key exists?
| key: str, | ||
| data: ObjectStoreItem, | ||
| ) -> None: | ||
| self._store[key] = data |
There was a problem hiding this comment.
Should throw an error if the key exists already
| return | ||
|
|
||
| async def get_object(self, key: str) -> ObjectStoreItem | str: | ||
| return self._store.get(key, f"No object found with key: {key}") |
There was a problem hiding this comment.
This should throw an exception if the key does not exist
| return self._store.get(key, f"No object found with key: {key}") | ||
|
|
||
| async def delete_object(self, key: str) -> None: | ||
| self._store.pop(key, None) |
There was a problem hiding this comment.
Exception if the key does not exist
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.
Description
This PR addresses https://jirasw.nvidia.com/browse/AIQ-846
By Submitting this PR I confirm: