Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add vector store integration of OceanBase for EmbedChain #1993

Closed
wants to merge 16 commits into from

Conversation

GITHUBear
Copy link

Description

OceanBase Database is a distributed relational database.
It is developed entirely by Ant Group. The OceanBase Database is built on a common server cluster.
Based on the Paxos protocol and its distributed structure, the OceanBase Database provides high availability and linear scalability.

OceanBase currently has the ability to store vectors. Here we introduce OceanBase as an alternative vector store.

You can deploy a standalone OceanBase server by following steps:

  1. Start a docker container via the following command:
docker run --name=ob433 -e MODE=slim -p 2881:2881 -d oceanbase/oceanbase-ce:4.3.3.0-100000142024101215
  1. Donwload the partner package:
pip install --upgrade --quiet pyobvector
  1. Check the connection to OceanBase and set the memory usage ratio for vector data:
from pyobvector import ObVecClient

tmp_client = ObVecClient()
tmp_client.perform_raw_text_sql(
    "ALTER SYSTEM ob_vector_memory_limit_percentage = 30"
)

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (does not change functionality, e.g. code style improvements, linting)
  • Documentation update

How Has This Been Tested?

unittest in embedchain/tests/vectordb/test_oceanbase.py

Please delete options that are not relevant.

  • Unit Test
  • Test Script (please provide)

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • I have checked my code and corrected any misspellings

Maintainer Checklist

  • closes #xxxx (Replace xxxx with the GitHub issue number)
  • Made sure Checks passed

Signed-off-by: shanhaikang.shk <[email protected]>
Signed-off-by: shanhaikang.shk <[email protected]>
Signed-off-by: shanhaikang.shk <[email protected]>
Signed-off-by: shanhaikang.shk <[email protected]>
Signed-off-by: shanhaikang.shk <[email protected]>
Signed-off-by: shanhaikang.shk <[email protected]>
Signed-off-by: shanhaikang.shk <[email protected]>
@CLAassistant
Copy link

CLAassistant commented Oct 30, 2024

CLA assistant check
All committers have signed the CLA.

@GITHUBear
Copy link
Author

Hi @Dev-Khant , could you please review my PR? Any feedback will be valuable. Thank you!

@HanMxSJ
Copy link

HanMxSJ commented Nov 4, 2024

Oceanbase is an important database of Alibaba Group, and OB's capabilities can help improve the adaptation of embedchain. The relevant code is very important to me, I need this feature, can you merge it ASAP.

@taranjeet
Copy link
Member

Hey @GITHUBear
Thank you for your contribution! At the moment, we’re focusing on integrations that are highly requested by the community. We appreciate your effort and will keep this in mind for future priorities.

@taranjeet taranjeet closed this Dec 3, 2024
@GITHUBear
Copy link
Author

@taranjeet Thank you for your reply! We are looking forward to future contributions, please remind us when it's ready for integration with OceanBase.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants