Skip to main content

LlamaIndex Vector_Stores Integration: Volcengine MySQL

This integration provides a VolcengineMySQLVectorStore that leverages the native vector index capabilities of Volcano engine Cloud Database for MySQL. It allows you to use RDS for MySQL as a fully-functional vector store in LlamaIndex for high-performance similarity search.

To learn more about the native vector feature in Volcengine RDS for MySQL, you can refer to its official documentation. This integration is specifically designed for Volcengine's enhanced MySQL and is not intended for standard community MySQL instances.

Installation

pip install llama-index-vector-stores-volcengine-mysql

Usage

from llama_index.vector_stores.volcengine_mysql import (
    VolcengineMySQLVectorStore,
)

# Initialize the vector store
vector_store = VolcengineMySQLVectorStore.from_params(
    host="your-rds-instance-host",
    port=3306,
    user="your-username",
    password="your-password",
    database="your-database",
    table_name="llama_index_vector_store",
    embed_dim=1536,  # Example: OpenAI embedding dimension
)

Requirements

To use this integration, you need a Volcengine RDS for MySQL instance with the following features enabled:

  • The loose_vector_index_enabled parameter set to ON.
  • Support for VECTOR(N) data type for columns.
  • Support for VECTOR INDEX (HNSW) for indexing.
  • Access to vector functions like TO_VECTOR(...), L2_DISTANCE(...), and COSINE_DISTANCE(...).

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

File details

Details for the file llama_index_vector_stores_volcengine_mysql-0.4.0.tar.gz.

File metadata

  • Download URL: llama_index_vector_stores_volcengine_mysql-0.4.0.tar.gz
  • Upload date:
  • Size: 10.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for llama_index_vector_stores_volcengine_mysql-0.4.0.tar.gz
Algorithm Hash digest
SHA256 f1a1c5e49a2861a1f42eb6befe1fba484afeb61bc0c61fdc792e7a8ac4d5df30
MD5 10471de62ac67b26ee8b9ca2063be7fc
BLAKE2b-256 b8406b673d441ef9c553b74008c70752203fe6c0b11cd8ff1ee87206c2f35cb4

See more details on using hashes here.

File details

Details for the file llama_index_vector_stores_volcengine_mysql-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: llama_index_vector_stores_volcengine_mysql-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for llama_index_vector_stores_volcengine_mysql-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f6320337a402f4038861dfce0fb1f7d304f352e523fcc7a7ed180e5c5b70a125
MD5 66b337710109ce49e52a0d443955c441
BLAKE2b-256 641a1f0a71f00ca1fca72386e14bb1d0c513d23126a5c6dd0058e2c95cc04a25

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.4.0 This release

2 files

0.3.0

2 files

0.2.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page