Skip to content

feat: Add OceanBase database support #851

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 72 additions & 0 deletions src/vanna/base/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -1661,6 +1661,78 @@ def run_sql_hive(sql: str) -> Union[pd.DataFrame, None]:
self.run_sql_is_set = True
self.run_sql = run_sql_hive


def connect_to_oceanbase(
self,
host: str = None,
user: str = None,
password: str = None,
database: str = None,
port: int = None,
**kwargs
):
"""
Connect to OceanBase database

Args:
host (str): OceanBase server address
user (str): Username
password (str): Password
database (str): Default database
port (int): Port number, default 2883
"""
try:
import pymysql # OceanBase uses MySQL protocol
except ImportError:
raise DependencyError(
"Required package: pip install pymysql"
)

# Get parameters from environment variables if not provided
host = host or os.getenv("OCEANBASE_HOST")
user = user or os.getenv("OCEANBASE_USER")
password = password or os.getenv("OCEANBASE_PASSWORD")
database = database or os.getenv("OCEANBASE_DATABASE")
port = database or os.getenv("OCEANBASE_PORT")

# Parameter validation
if not all([host, user, password, database, port]):
raise ImproperlyConfigured("Missing OceanBase connection parameters")

try:
# Establish connection
conn = pymysql.connect(
host=host,
user=user,
password=password,
database=database,
port=port,
cursorclass=pymysql.cursors.DictCursor,
**kwargs
)
except pymysql.Error as e:
raise ValidationError(f"Connection failed: {e}")

# Define SQL execution function
def run_sql_oceanbase(sql: str) -> pd.DataFrame:
try:
with conn.cursor() as cursor:
cursor.execute(sql)
result = cursor.fetchall()
df = pd.DataFrame(result)
return df
except pymysql.Error as e:
conn.rollback()
raise ValidationError(f"SQL execution error: {e}")
except Exception as e:
conn.rollback()
raise e

# Set class properties
self.dialect = "OceanBase/MySQL" # MySQL compatible mode
self.run_sql = run_sql_oceanbase
self.run_sql_is_set = True

def run_sql(self, sql: str, **kwargs) -> pd.DataFrame:
"""
Example:
Expand Down