Infinity

https://infiniflow.org/docs
Admin
Infinity is an open-source database designed for vector, full-text, and hybrid searches, providing a...
Tokens:240,930
Snippets:1,271
Trust Score:6.8
Update:10 months ago
Show doc for...
Tokens:
Raw
### Install Infinity Client using pip

Source: https://infiniflow.org/docs/dev

Command to install the Infinity SDK for Python, allowing interaction with the Infinity database. Ensure you have Python 3.10+ installed.

```shell
pip install infinity-sdk==0.6.7  
```

--------------------------------

### Install Infinity Server on Fedora/RHEL/CentOS/OpenSUSE

Source: https://infiniflow.org/docs/dev/deploy_infinity_server

Installs the Infinity server using an RPM package and starts the server service. Requires root privileges and a compatible Linux distribution.

```bash
sudo rpm -i infinity-0.6.7-x86_64.rpm  

```

```bash
sudo systemctl start infinity  

```

--------------------------------

### Show Configurations - cURL Example

Source: https://infiniflow.org/docs/v0.5.2/http_api_reference

Example of retrieving all configuration parameters using cURL. This command sends a GET request to the /configs endpoint.

```shell
curl --request GET \
     --url http://localhost:23820/configs \
     --header 'accept: application/json'
```

--------------------------------

### Start Infinity Server via Systemd

Source: https://infiniflow.org/docs/v0.5.2/deploy_infinity_server

Starts the Infinity server using systemctl. Assumes the server was installed via a package manager (e.g., RPM or DEB).

```bash
sudo systemctl start infinity
```

--------------------------------

### Deploy Infinity Server using Docker (Linux/macOS)

Source: https://infiniflow.org/docs/dev

Commands to set up the Infinity server directory, pull the Docker image, and run the Infinity server as a detached container. This assumes a Linux or macOS environment.

```shell
sudo mkdir -p /var/infinity && sudo chown -R $USER /var/infinity  
docker pull infiniflow/infinity:nightly  
docker run -d --name infinity -v /var/infinity/:/var/infinity --ulimit nofile=500000:500000 --network=host infiniflow/infinity:nightly  
```

--------------------------------

### Run a Vector Search with Infinity Python SDK

Source: https://infiniflow.org/docs/dev

Python code demonstrating how to connect to the Infinity server, create a table, insert data with vector embeddings, perform a vector similarity search, and retrieve results.

```python
import infinity  
  
infinity_obj = infinity.connect(infinity.NetworkAddress("<SERVER_IP_ADDRESS>", 23817))   
db_object = infinity_object.get_database("default_db")  
table_object = db_object.create_table("my_table", {"num": {"type": "integer"}, "body": {"type": "varchar"}, "vec": {"type": "vector, 4, float"}})"})")  
table_object.insert([{"num": 1, "body": "unnecessary and harmful", "vec": [1.0, 1.2, 0.8, 0.9]}])  
table_object.insert([{"num": 2, "body": "Office for Harmful Blooms", "vec": [4.0, 4.2, 4.3, 4.5]}])  
res = table_object.output(["*"])  
                  .match_dense("vec", [3.0, 2.8, 2.7, 3.1], "float", "ip", 2)  
                  .to_pl()  
print(res)  
```

--------------------------------

### Run a Vector Search using Infinity Python SDK

Source: https://infiniflow.org/docs/index

Demonstrates how to connect to an Infinity server, create a table, insert data, perform a vector search, and retrieve results using the Infinity Python SDK. Requires a running Infinity server and the infinity-sdk package.

```python
import infinity  

infinity_obj = infinity.connect(infinity.NetworkAddress("<SERVER_IP_ADDRESS>", 23817))   
db_object = infinity_object.get_database("default_db")  
table_object = db_object.create_table("my_table", {"num": {"type": "integer"}, "body": {"type": "varchar"}, "vec": {"type": "vector, 4, float"}})"
table_object.insert([{"num": 1, "body": "unnecessary and harmful", "vec": [1.0, 1.2, 0.8, 0.9]}])  
table_object.insert([{"num": 2, "body": "Office for Harmful Blooms", "vec": [4.0, 4.2, 4.3, 4.5]}])  
res = table_object.output(["*"])  
                  .match_dense("vec", [3.0, 2.8, 2.7, 3.1], "float", "ip", 2)  
                  .to_pl()  
print(res)  
```

--------------------------------

### Install Infinity Server on Ubuntu/Debian

Source: https://infiniflow.org/docs/dev/deploy_infinity_server

Installs the Infinity server using a DEB package and starts the server service. Requires root privileges and a compatible Linux distribution (Debian or Ubuntu based).

```bash
sudo dpkg -i infinity-0.6.7-x86_64.deb  

```

```bash
sudo systemctl start infinity  

```

--------------------------------

### Infinity Configuration File Example

Source: https://infiniflow.org/docs/configurations

A TOML formatted example of an Infinity configuration file. It includes sections for general settings, network configuration, logging parameters, and storage options, with comments explaining each parameter.

```toml
[general]  
# Infinity server version, the minor version of this parameter should match server minor version.  
version                  = "0.6.7"  
# Timezone  
time_zone                = "utc-8"  
# The number of worker threads. Defaults to the number of CPU cores.  
# Range: [1, 16384]  
cpu_limit                = 8  
# The mode in which the server starts. Available options:  
# - \"standalone\": Start Infinity as a standalone server.  
# - \"admin\":  
#   - Start Infinity either as a standalone server in `ADMIN` mode (when `storage_type` is set to `"local"`)  
#   - Start Infinity as a cluster node in `ADMIN` mode (when `storage_type` is set to `"minio"`)  
server_mode              = "standalone"  
  
# Network configuration  
[network]  
# IP address of the Infinity server  
server_address           = "0.0.0.0"  
  
# Port of the Postgres server  
postgres_port            = 5432  
# Port of the HTTP server  
http_port                = 23820  
# Port of the Python SDK server  
client_port              = 23817  
# The maximum number of connections. Defaults to 256.  
# Range: [1, 65536]  
connection_pool_size     = 128  
# The IP address on which the current node listens. Used for registration and inter-node communication  
peer_ip                  = "0.0.0.0"  
# The port number on which the current node listens. Used for registration and inter-node communication  
peer_port                = 23850  
  
# The delay time for reconnecting to the Infinity peer server after a failed connection  
peer_retry_delay         = 0  
# The maximum number of reconnection attempts to the Infinity peer server after a failed connection  
peer_retry_count           = 0  
# Timeout for connecting to the Infinity peer server  
peer_connect_timeout     = 2000  
# Timeout for the Infinity peer server to receive data  
peer_recv_timeout        = 0  
# Timeout for the Infinity peer server to send data  
peer_send_timeout        = 0  
  
# Log configuration  
[log]  
# Filename of the log files.  
log_filename             = "infinity.log"  
# Directory for the log files.  
log_dir                  = "/var/infinity/log"  
# Controls whether to print the log to the standard output. Defaults to true  
# Range: {true|false}   
log_to_stdout            = true  
# The maximum size of each log file. Defaults to "1GB".  
# Range: at least 1GB  
log_file_max_size        = "10GB"  
# The number of rotating log files. Defaults to 8  
# Range: [1, 655636]  
log_file_rotate_count    = 10  
# The log output level. Defaults to "info".  
# Range: {"trace"/"debug"/"info"/"warning"/"error"/"critical"}  
log_level               = "info"  
  
# Storage configuration  
[storage]  
# The working directory of the persistence manager:  
# - Holds the data that Infinity saves when using the local disk for storage.  
# - Caches the accessed object files when using MinIO/S3 for object storage.  
persistence_dir          = "/var/infinity/persistence"  
  
# Garbage collection period  
# Defined as "number + unit of time":  
# - s for seconds (e.g., "60s" for 60 seconds),  
# - m for minutes (e.g., "60m" for 60 minutes),  
# - h for hours (e.g., "1h" for one hour).  
# To disable a specific periodic task, set the corresponding variable to "0s"  
  
# Interval between index optimization tasks  
# Range: ["10s", "720h"]  
optimize_interval        = "10s"  
# Interval between cleanup tasks  
# Range: ["10s", "720h"]  
cleanup_interval         = "60s"  
# Interval between compaction tasks  
# Range: ["10s", "720h"]  
compact_interval         = "120s"  
# The threshold for flushing an in-memory index to disk.  
# When the number of rows in the index exceeds this threshold,  
# the system performs a flush operation on that index.  
# Range: [8192, 8388608]  
mem_index_capacity       = 65536  
# The type of storage to use. Available options:  
# - `"local"`: (default)  
# - `"minio"`: If you set `server_mode` to `"admin"` and `storage_type` to `"minio"`, the node will start as a cluster node in `ADMIN` mode.  

```

--------------------------------

### Install Benchmark Dependencies

Source: https://infiniflow.org/docs/benchmark

This section outlines the steps to install the necessary Python dependencies for running the Infiniflow benchmarks. It involves navigating to the 'python' directory, installing requirements, and then installing the Infiniflow package itself.

```bash
cd python

pip install -r requirements.txt
pip install .
```

--------------------------------

### Start Infinity Server

Source: https://infiniflow.org/docs/build_from_source

Starts the Infinity server after it has been built. Ensures necessary directories are created and permissions are set.

```bash
sudo mkdir -p /var/infinity && sudo chown -R $USER /var/infinity
ulimit -n 500000
./cmake-build-debug/src/infinity
```

--------------------------------

### Install Infinity Client SDK

Source: https://infiniflow.org/docs/dev/deploy_infinity_server

Installs the Infinity client SDK using pip. This package allows interaction with the Infinity database from Python applications. Ensure pip is installed and configured.

```python
pip install infinity-sdk==0.6.7  

```

--------------------------------

### Infinity Configuration File Example

Source: https://infiniflow.org/docs/dev/configurations

An example TOML configuration file for Infinity. It includes settings for general server parameters, network configuration, logging, and storage options.

```toml
[general]
# Infinity server version, the minor version of this parameter should match server minor version.
version                  = "0.6.7"
# Timezone
time_zone                = "utc-8"
# The number of worker threads. Defaults to the number of CPU cores.
# Range: [1, 16384]
cpu_limit                = 8
# The mode in which the server starts. Available options:
# - `"standalone"`: Start Infinity as a standalone server.
# - `"admin"`:
#   - Start Infinity either as a standalone server in `ADMIN` mode (when `storage_type` is set to `"local"`)
#   - Start Infinity as a cluster node in `ADMIN` mode (when `storage_type` is set to `"minio"`)
server_mode              = "standalone"

# Network configuration
[network]
# IP address of the Infinity server
server_address           = "0.0.0.0"

# Port of the Postgres server
postgres_port            = 5432
# Port of the HTTP server
http_port                = 23820
# Port of the Python SDK server
client_port              = 23817
# The maximum number of connections. Defaults to 256.
# Range: [1, 65536]
connection_pool_size     = 128
# The IP address on which the current node listens. Used for registration and inter-node communication
peer_ip                  = "0.0.0.0"
# The port number on which the current node listens. Used for registration and inter-node communication
peer_port                = 23850

# The delay time for reconnecting to the Infinity peer server after a failed connection
peer_retry_delay         = 0
# The maximum number of reconnection attempts to the Infinity peer server after a failed connection
peer_retry_count           = 0
# Timeout for connecting to the Infinity peer server
peer_connect_timeout     = 2000
# Timeout for the Infinity peer server to receive data
peer_recv_timeout        = 0
# Timeout for the Infinity peer server to send data
peer_send_timeout        = 0

# Log configuration
[log]
# Filename of the log files.
log_filename             = "infinity.log"
# Directory for the log files.
log_dir                  = "/var/infinity/log"
# Controls whether to print the log to the standard output. Defaults to true
# Range: {true|false}
log_to_stdout            = true
# The maximum size of each log file. Defaults to "1GB".
# Range: at least 1GB
log_file_max_size        = "10GB"
# The number of rotating log files. Defaults to 8
# Range: [1, 655636]
log_file_rotate_count    = 10
# The log output level. Defaults to "info".
# Range: {"trace"/"debug"/"info"/"warning"/"error"/"critical"}
log_level               = "info"

# Storage configuration
[storage]
# The working directory of the persistence manager:
# - Holds the data that Infinity saves when using the local disk for storage.
# - Caches the accessed object files when using MinIO/S3 for object storage.
persistence_dir          = "/var/infinity/persistence"

# Garbage collection period
# Defined as "number + unit of time":
# - s for seconds (e.g., "60s" for 60 seconds),
# - m for minutes (e.g., "60m" for 60 minutes),
# - h for hours (e.g., "1h" for one hour).
# To disable a specific periodic task, set the corresponding variable to "0s"

# Interval between index optimization tasks
# Range: ["10s", "720h"]
optimize_interval        = "10s"
# Interval between cleanup tasks
# Range: ["10s", "720h"]
cleanup_interval         = "60s"
# Interval between compaction tasks
# Range: ["10s", "720h"]
compact_interval         = "120s"
# The threshold for flushing an in-memory index to disk.
# When the number of rows in the index exceeds this threshold,
# the system performs a flush operation on that index.
# Range: [8192, 8388608]
mem_index_capacity       = 65536
# The type of storage to use. Available options:
# - `"local"`: (default)

```

--------------------------------

### Show Files API Request Example (curl)

Source: https://infiniflow.org/docs/v0.5.2/http_api_reference

Provides an example using curl to fetch a list of files managed by the persistent manager. This uses a GET request to the /instance/files endpoint.

```bash
curl --request GET \
    --url http://localhost:23821/instance/files \
    --header 'accept: application/json'
```

--------------------------------

### Install Infinity Client SDK

Source: https://infiniflow.org/docs/v0.5.2/deploy_infinity_server

Installs the Infinity client SDK using pip. This is necessary for interacting with a deployed Infinity instance.

```bash
pip install infinity-sdk==0.5.2
```

--------------------------------

### Install Benchmark Dependencies (Python)

Source: https://infiniflow.org/docs/dev/benchmark

Installs the necessary Python packages for running the benchmark tests using pip. Ensure you are in the correct directory before running.

```bash
cd python/benchmark
pip install -r requirements.txt
```

--------------------------------

### Install Benchmark Dependencies

Source: https://infiniflow.org/docs/dev/benchmark

This command installs the necessary Python dependencies for running the benchmarks, including any libraries required by the Infiniflow benchmarking scripts. It assumes you are in the 'python' directory and have a 'requirements.txt' file.

```bash
cd python  
  
pip install -r requirements.txt  
pip install .  

```

--------------------------------

### Install Benchmark Dependencies

Source: https://infiniflow.org/docs/v0.5.2/benchmark

This command installs the necessary Python packages for running the Infiniflow benchmarks. It requires navigating to the 'python' directory and then installing from the 'requirements.txt' file and the package itself.

```bash
cd python

pip install -r requirements.txt
pip install .

```

--------------------------------

### Install Build Dependencies on Ubuntu

Source: https://infiniflow.org/docs/build_from_source

Installs essential build tools like git, wget, unzip, and CMake on Ubuntu systems. Also installs Ninja build system and Mold linker.

```bash
sudo apt update && sudo apt install git wget unzip software-properties-common
wget https://github.com/Kitware/CMake/releases/download/v4.0.3/cmake-4.0.3-linux-x86_64.tar.gz
tar zxvf cmake-4.0.3-linux-x86_64.tar.gz
sudo cp -rf cmake-4.0.3-linux-x86_64/bin/* /usr/local/bin && sudo cp -rf cmake-4.0.3-linux-x86_64/share/* /usr/local/share && rm -rf cmake-4.0.3-linux-x86_64
wget https://github.com/ninja-build/ninja/archive/refs/tags/v1.13.1.zip
unzip v1.13.1.zip && cd ninja-1.13.1 && cmake -Bbuild-cmake -DBUILD_TESTING=OFF && cmake --build build-cmake --parallel $(nproc) && cd build-cmake && sudo cp ninja /usr/local/bin
cd ../.. && rm -rf v1.13.1.zip ninja-1.13.1
wget https://github.com/rui314/mold/archive/refs/tags/v2.40.3.zip
./install-build-deps.sh
```

--------------------------------

### Install Infinity Python SDK

Source: https://infiniflow.org/docs/v0.5.2/build_from_source

Installs a specific version of the Infinity Python SDK using pip, which is necessary for running functional tests.

```bash
pip install infinity-sdk==0.5.2  
```

--------------------------------

### Build and Run Functional Tests Locally

Source: https://infiniflow.org/docs/build_from_source

Builds and starts the Infinity server locally, installs the Python SDK, and then runs functional tests. This is a direct method for testing without Docker. Dependencies include CMake, Python 3, and the `infinity-sdk`.

```bash
cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug -DCMAKE_VERBOSE_MAKEFILE=ON ..
cmake --build . -t infinity
./cmake-build-debug/src/infinity
pip install infinity-sdk==0.6.7
python3 tools/run_pytest_parallel.py
```

--------------------------------

### Build and Run Functional Tests with Code Coverage

Source: https://infiniflow.org/docs/build_from_source

Builds and starts the Infinity server with code coverage enabled, installs the Python SDK, runs functional tests, and then shuts down the server. Code coverage data is collected using LLVM tools. Dependencies include CMake, Python 3, `infinity-sdk`, and LLVM tools.

```bash
cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug -DCMAKE_VERBOSE_MAKEFILE=ON -DCODE_COVERAGE=ON ..
cmake --build . -t infinity
find . -name "infinity*.profraw"  | xargs rm -f
export LLVM_PROFILE_FILE="infinity-%p.profraw"
export LLVM_PROFILE_DUMP_ON_EXIT=1
./cmake-build-debug/src/infinity
pip install infinity-sdk==0.6.7
python3 tools/run_pytest_parallel.py
kill `pidof infinity`
```

--------------------------------

### Build and Run Functional Tests with Code Coverage

Source: https://infiniflow.org/docs/dev/build_from_source

Builds the Infiniflow server with code coverage enabled and runs functional tests. It sets up coverage collection, starts the server, installs the Python SDK, runs tests, and then generates a code coverage report.

```bash
cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug -DCMAKE_VERBOSE_MAKEFILE=ON -DCODE_COVERAGE=ON ..  
cmake --build . -t infinity  
find . -name "infinity*.profraw"  | xargs rm -f  
export LLVM_PROFILE_FILE="infinity-%p.profraw"  
export LLVM_PROFILE_DUMP_ON_EXIT=1  
./cmake-build-debug/src/infinity  
pip install infinity-sdk==0.6.7  
python3 tools/run_pytest_parallel.py  
kill `pidof infinity`  
```

--------------------------------

### Install GCC 15 and LLVM 20

Source: https://infiniflow.org/docs/dev/build_from_source

Installs GCC 15 and LLVM 20 compilers and their associated tools. It also sets up system alternatives to prioritize these versions.

```shell
sudo add-apt-repository ppa:puni070/gcc-noble
sudo apt update
sudo apt install gcc-15 g++-15
sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-15  100
sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-15  100
cd ~/Downloads
git clone https://github.com/microsoft/vcpkg.git
cd vcpkg && ./bootstrap-vcpkg.sh -disableMetrics
sh -c 'cat <<EOF >> ~/.bashrc  
export VCPKG_ROOT=${PWD}  
export PATH=${VCPKG_ROOT}:${PATH}  
EOF'
source ~/.bashrc
wget https://apt.llvm.org/llvm.sh && chmod +x llvm.sh && sudo ./llvm.sh 20 && rm llvm.sh
sudo apt install -y clang-tools-20 flex zlib1g-dev python3-dev autoconf libjemalloc-dev
sudo update-alternatives --install /usr/bin/clang clang /usr/bin/clang-20 100
sudo ln -s /usr/lib/llvm-20/bin/clang-scan-deps /usr/bin/clang-scan-deps
sudo ln -s /usr/bin/clang-format-20 /usr/bin/clang-format
sudo ln -s /usr/bin/clang-tidy-20 /usr/bin/clang-tidy
sudo ln -s /usr/bin/llvm-symbolizer-20 /usr/bin/llvm-symbolizer
sudo ln -s /usr/lib/llvm-20/include/x86_64-pc-linux-gnu/c++/v1/__config_site /usr/lib/llvm-20/include/c++/v1/__config_site
```

--------------------------------

### Install Infinity Server via DEB

Source: https://infiniflow.org/docs/v0.5.2/deploy_infinity_server

Installs the Infinity server package using DPKG. This is for Ubuntu/Debian distributions.

```bash
sudo dpkg -i infinity-0.5.2-x86_64.deb
```

--------------------------------

### Admin Show Node Configurations Request Example (curl)

Source: https://infiniflow.org/docs/v0.5.2/http_api_reference

This snippet illustrates how to fetch all node configurations using a GET request to the /admin/configs endpoint. The request requires an 'accept: application/json' header. The response, typically with a 200 status code, returns a JSON object containing detailed configuration parameters of the node.

```curl
curl --request GET \
    --url http://localhost:23821/admin/configs \
    --header 'accept: application/json'
```

--------------------------------

### Install Infinity Server via RPM

Source: https://infiniflow.org/docs/v0.5.2/deploy_infinity_server

Installs the Infinity server package using RPM. This is for Fedora/RHEL/CentOS/OpenSUSE distributions.

```bash
sudo rpm -i infinity-0.5.2-x86_64.rpm
```

--------------------------------

### Install Gcovr for Code Coverage

Source: https://infiniflow.org/docs/v0.5.2/build_from_source

Installs the Gcovr dependency using pip, which is required for generating code coverage reports.

```bash
pip install gcovr  
```

--------------------------------

### Build and Install Mold Linker v2.40.3

Source: https://infiniflow.org/docs/dev/build_from_source

Compiles and installs the Mold linker version 2.40.3. This linker is known for its speed and is used in the build process.

```shell
wget https://github.com/rui314/mold/archive/refs/tags/v2.40.3.zip
./install-build-deps.sh
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER=g++-15 -B build
cmake --build build -j$(nproc)
sudo cmake --build build --target install
```

--------------------------------

### Show All Configurations Success Response Example (JSON)

Source: https://infiniflow.org/docs/http_api_reference

Example of a successful JSON response when retrieving all configurations. It includes various configuration parameters and an error_code of 0.

```json
{
    "buffer_manager_size":"4294967296",
    "cleanup_interval":"10",
    "client_port":"23817",
    "compact_interval":"10",
    "connection_pool_size":"256",
    "cpu_limit":"16",
    "data_dir":"/var/infinity/data",
    "error_code":0,
    "checkpoint_interval":"30",
    "http_port":"23820",
    "log_dir":"/var/infinity/log",
    "log_file_max_size":"1073741824",
    "log_file_rotate_count":"8",
    "log_filename":"infinity.log",
    "log_level":"Info",
    "log_to_stdout":"False",
    "mem_index_capacity":"65536",
    "optimize_interval":"10",
    "postgres_port":"5432",
    "resource_dir":"/usr/share/infinity/resource",
    "server_address":"0.0.0.0",
    "temp_dir":"/var/infinity/tmp",
    "time_zone":"UTC+8",
    "version":"0.6.7",
    "wal_compact_threshold":"1073741824",
    "wal_dir":"/var/infinity/wal",
    "wal_flush":"FlushAtOnce"
}
```

--------------------------------

### Install LLVM 20 Dependency

Source: https://infiniflow.org/docs/dev/build_from_source

Installs the `llvm-20` package, which is a prerequisite for enabling code coverage features during the build and testing process of the Infiniflow project on Ubuntu systems.

```bash
sudo apt install llvm-20  
```

--------------------------------

### Install CMake 4.0.3 and Ninja v1.13.1

Source: https://infiniflow.org/docs/dev/build_from_source

Downloads and installs CMake version 4.0.3 and Ninja build system version 1.13.1. This ensures the necessary build tools are available for compiling the project.

```shell
sudo apt update && sudo apt install -y git wget lsb-release software-properties-common
wget https://github.com/Kitware/CMake/releases/download/v4.0.3/cmake-4.0.3-linux-x86_64.tar.gz
tar zxvf cmake-4.0.3-linux-x86_64.tar.gz
sudo cp -rf cmake-4.0.3-linux-x86_64/bin/* /usr/local/bin && sudo cp -rf cmake-4.0.3-linux-x86_64/share/* /usr/local/share && rm -rf cmake-4.0.3-linux-x86_64
wget https://github.com/ninja-build/ninja/archive/refs/tags/v1.13.1.zip
unzip v1.13.1.zip && cd ninja-1.13.1 && cmake -Bbuild-cmake -DBUILD_TESTING=OFF && cmake --build build-cmake --parallel $(nproc) && cd build-cmake && sudo cp ninja /usr/local/bin
cd ../.. && rm -rf v1.13.1.zip ninja-1.13.1
```

--------------------------------

### Install LLVM Dependency for Code Coverage

Source: https://infiniflow.org/docs/build_from_source

Installs the `llvm-20` package on Ubuntu, which is required for enabling and processing code coverage data. This is a prerequisite for generating code coverage reports.

```bash
sudo apt install llvm-20
```

--------------------------------

### Infiniflow API GET Request Example with Search Parameters

Source: https://infiniflow.org/docs/dev/http_api_reference

Demonstrates a GET request to retrieve documents from a specific table within a database. It includes detailed search parameters for dense, text, and sparse matching, along with a fusion method (rrf) for combining results. This example showcases flexible querying capabilities.

```curl
curl --request GET \
     --url http://localhost:23820/databases/{database_name}/tables/{table_name}/docs \
     --header 'accept: application/json' \
    --header 'content-type: application/json' \
    --data '   
    {
        "output":  
        [  
            "name",  
            "score",  
            "body"  
        ],  
        "highlight":  
        [  
            "body"  
        ],  
        "filter": "score >= 4.0 and name = \'\'Toby\'\'",  
        "search":  
        [  
            {  
                "match_method": "dense",  
                "fields": "dense_column",  
                "query_vector": [1.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0, 0.0],  
                "element_type": "float",  
                "metric_type": "l2",  
                "topn": 2,  
                "params": {"ef": "10"}  
            },  
            {  
                "match_method": "text",  
                "fields": "body",  
                "matching_text": "bloom",  
                "topn": 1,  
                "params":  
                {  
                    "default_fields": "body",  
                    "operator": "or"  
                }  
            },  
            {  
                "match_method": "sparse",  
                "fields": "sparse_column",  
                "query_vector": {"10":1.1, "20":2.2, "30": 3.3},  
                "metric_type": "ip",  
                "topn": 3,  
                "params":  
                {  
                              "alpha": "1.0",  
                              "beta": "1.0"  
                          }     
            },  
            {  
                "fusion_method": "rrf",  
                "topn": 2,  
                "params":{"rank_constant": "60"}  
            }  
        ]  
    } '
```

--------------------------------

### Export Table Data GET Request Example (curl)

Source: https://infiniflow.org/docs/http_api_reference

This code snippet demonstrates how to export data from a table using a GET request. It specifies the target database and table, along with various parameters to control the export, such as file path, type, delimiter, and row limits. The example uses curl for clarity.

```curl
curl --request GET \
     --url http://localhost:23820/databases/{database_name}/table/{table_name} \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data ' {  
         "file_path": "/var/infinity/filename.csv",  
         "file_type": "csv",  
         "header": false,   
         "delimiter": "\t",  
         "offset": 2,  
         "limit": 6,  
         "row_limit": 2  
    } '
```

--------------------------------

### Install vcpkg, GCC 15, LLVM, Jemalloc, CMake, Ninja, and Mold

Source: https://infiniflow.org/docs/build_from_source

This snippet covers the installation of essential development tools including vcpkg for package management, specific versions of GCC and LLVM for compilation, jemalloc for memory allocation, CMake for build system generation, Ninja as a build tool, and mold as a linker. It also includes steps to add these tools to the system's PATH and update alternatives to prioritize the newly installed versions.

```bash
cd ~/Downloads # Of course, you can specify a different path.
git clone https://github.com/microsoft/vcpkg.git
cd vcpkg && ./bootstrap-vcpkg.sh -disableMetrics
sh -c 'cat <<EOF >> ~/.bashrc  
export VCPKG_ROOT=${PWD}  
export PATH=${VCPKG_ROOT}:${PATH}  
EOF'
source ~/.bashrc
wget https://apt.llvm.org/llvm.sh && chmod +x llvm.sh && sudo ./llvm.sh 20 && rm llvm.sh
sudo add-apt-repository -P ppa:ubuntu-toolchain-r/test
sudo apt update && sudo apt install clang-tools-20 flex zlib1g-dev python3-dev autoconf
wget https://github.com/jemalloc/jemalloc/archive/refs/tags/5.3.0.tar.gz
tar zxvf 5.3.0.tar.gz && cd jemalloc-5.3.0 && ./autogen.sh && CFLAGS="-fPIC" CXXFLAGS="-fPIC" ./configure --enable-static --disable-libdl --enable-prof --enable-prof-libunwind --disable-initial-exec-tls && sudo make -j install && cd ..
sudo ldconfig && sudo rm -rf jemalloc-5.3.0 5.3.0.tar.gz
sudo ln -s /usr/lib/llvm-20/bin/clang-scan-deps /usr/bin/clang-scan-deps
sudo ln -s /usr/bin/clang-format-20 /usr/bin/clang-format
sudo ln -s /usr/bin/clang-tidy-20 /usr/bin/clang-tidy
sudo ln -s /usr/bin/llvm-symbolizer-20 /usr/bin/llvm-symbolizer
sudo ln -s /usr/lib/llvm-20/include/x86_64-pc-linux-gnu/c++/v1/__config_site /usr/lib/llvm-20/include/c++/v1/__config_site


sudo apt update && sudo apt install -y git wget lsb-release software-properties-common
wget https://github.com/Kitware/CMake/releases/download/v4.0.3/cmake-4.0.3-linux-x86_64.tar.gz
tar zxvf cmake-4.0.3-linux-x86_64.tar.gz
sudo cp -rf cmake-4.0.3-linux-x86_64/bin/* /usr/local/bin && sudo cp -rf cmake-4.0.3-linux-x86_64/share/* /usr/local/share && rm -rf cmake-4.0.3-linux-x86_64
wget https://github.com/ninja-build/ninja/archive/refs/tags/v1.13.1.zip
unzip v1.13.1.zip && cd ninja-1.13.1 && cmake -Bbuild-cmake -DBUILD_TESTING=OFF && cmake --build build-cmake --parallel $(nproc) && cd build-cmake && sudo cp ninja /usr/local/bin
cd ../.. && rm -rf v1.13.1.zip ninja-1.13.1
wget https://github.com/rui314/mold/archive/refs/tags/v2.40.3.zip
./install-build-deps.sh
cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_COMPILER=g++-15 -B build
cmake --build build -j$(nproc)
sudo cmake --build build --target install
sudo add-apt-repository ppa:puni070/gcc-noble
sudo apt update
sudo apt install gcc-15 g++-15
# Ensure that no other gcc&g++ versions have a priority set, or that if they do, their priority is below 100.  
sudo update-alternatives --install /usr/bin/gcc gcc /usr/bin/gcc-15  100  
sudo update-alternatives --install /usr/bin/g++ g++ /usr/bin/g++-15  100  
cd ~/Downloads # Of course, you can specify a different path.  
git clone https://github.com/microsoft/vcpkg.git
cd vcpkg && ./bootstrap-vcpkg.sh -disableMetrics
sh -c 'cat <<EOF >> ~/.bashrc  
export VCPKG_ROOT=${PWD}  
export PATH=${VCPKG_ROOT}:${PATH}  
EOF'
source ~/.bashrc
wget https://apt.llvm.org/llvm.sh && chmod +x llvm.sh && sudo ./llvm.sh 20 && rm llvm.sh
sudo apt install -y clang-tools-20 flex zlib1g-dev python3-dev autoconf libjemalloc-dev
# Ensure that no other Clang versions have a priority set, or that if they do, their priority is below 100.  
sudo update-alternatives --install /usr/bin/clang clang /usr/bin/clang-20 100  
sudo ln -s /usr/lib/llvm-20/bin/clang-scan-deps /usr/bin/clang-scan-deps
sudo ln -s /usr/bin/clang-format-20 /usr/bin/clang-format
sudo ln -s /usr/bin/clang-tidy-20 /usr/bin/clang-tidy
sudo ln -s /usr/bin/llvm-symbolizer-20 /usr/bin/llvm-symbolizer
sudo ln -s /usr/lib/llvm-20/include/x86_64-pc-linux-gnu/c++/v1/__config_site /usr/lib/llvm-20/include/c++/v1/__config_site
```

--------------------------------

### Get Variable Success Response Example (JSON)

Source: https://infiniflow.org/docs/http_api_reference

Example of a successful JSON response when retrieving a variable. It includes an error_code of 0 indicating success and a buffer_object_count.

```json
{
    "error_code": 0,
    "buffer_object_count":"6"
}
```

--------------------------------

### Start Databases for Benchmark (Docker)

Source: https://infiniflow.org/docs/dev/benchmark

Launches Docker containers for Elasticsearch, Qdrant, Quickwit, and Infinity, configuring necessary volumes and network settings for benchmarking. Each command ensures the database is set up to run in a standalone or host network mode.

```bash
mkdir -p $HOME/elasticsearch/data
docker run -d --name elasticsearch --network host -e "discovery.type=single-node" -e "ES_JAVA_OPTS=-Xms16384m -Xmx32000m" -e "xpack.security.enabled=false" -v $HOME/elasticsearch/data:/usr/share/elasticsearch/data elasticsearch:8.13.4

mkdir -p $HOME/qdrant/storage
docker run -d --name qdrant --network host -v $HOME/qdrant/storage:/qdrant/storage qdrant/qdrant:v1.9.2

mkdir -p $HOME/quickwit
docker run -d --name quickwit --network=host -v $HOME/quickwit/qwdata:/quickwit/qwdata quickwit/quickwit:0.8.1 run

mkdir -p $HOME/infinity
docker run -d --name infinity --network=host -v $HOME/infinity:/var/infinity --ulimit nofile=500000:500000 infiniflow/infinity:nightly
```

--------------------------------

### Get Variable Error Response Example (JSON)

Source: https://infiniflow.org/docs/http_api_reference

Example of an error JSON response when attempting to retrieve a non-existent variable. It includes a non-zero error_code and an error_msg detailing the issue.

```json
{
    "error_code": 3027,
    "error_msg": "No such system variable {variable_name}."
}
```

--------------------------------

### Show Buffer Objects - cURL Example

Source: https://infiniflow.org/docs/v0.5.2/http_api_reference

Example of listing cached buffer objects in the database using cURL. This command sends a GET request to the /instance/buffer endpoint.

```shell
curl --request GET \
     --url http://localhost:23820/instance/buffer \
     --header 'accept: application/json'
```

--------------------------------

### Show All Global Variables (GET Request)

Source: https://infiniflow.org/docs/v0.5.2/http_api_reference

Example of a cURL request to retrieve all global variables in the Infinity system using the GET method. It requires the 'accept' header and targets the '/variables' endpoint.

```bash
curl --request GET \
     --url http://localhost:23820/variables \
     --header 'accept: application/json'
```

--------------------------------

### Show Specific Global Variable (GET Request)

Source: https://infiniflow.org/docs/v0.5.2/http_api_reference

Example of a cURL request to retrieve the value of a specific global variable using the GET method. It targets the '/variables/{variable_name}' endpoint and requires the 'accept' header.

```bash
curl --request GET \
     --url http://localhost:23820/variables/{variable_name} \
     --header 'accept: application/json'
```

--------------------------------

### Show Specific Configuration - cURL Example

Source: https://infiniflow.org/docs/v0.5.2/http_api_reference

Example of retrieving a specific configuration parameter's value using cURL. This command sends a GET request to the /configs/{config_name} endpoint, where {config_name} is the parameter to retrieve.

```shell
curl --request GET \
     --url http://localhost:23820/configs/{config_name} \
     --header 'accept: application/json'
```

--------------------------------

### Load Infinity Config with Docker

Source: https://infiniflow.org/docs/configurations

Demonstrates how to load a configuration file for Infinity when using Docker. This involves mounting the configuration directory and specifying the file path using the `-f` option in the `docker run` command.

```shell
docker run -d --name infinity -v /var/infinity/:/var/infinity --ulimit nofile=500000:500000 --network=host infiniflow/infinity:nightly -f /var/infinity/infinity_conf.toml  

```

--------------------------------

### Infiniflow Show Object Response JSON Example (Status Code 200)

Source: https://infiniflow.org/docs/v0.5.2/http_api_reference

An example of a successful JSON response (HTTP status code 200) for the 'Show object' endpoint. It returns an error_code of 0 and an 'object' array containing start and end ranges.

```json
{
    "error_code": 0,
    "object": [
        {
            "end": "426120",
            "start": "0"
        }
    ]
}
```

--------------------------------

### Search Data - GET Request Example

Source: https://infiniflow.org/docs/dev/http_api_reference

Retrieves data from a specified table using a GET request. This endpoint supports various search types, including vector, sparse vector, full-text, and hybrid searches. The request can include parameters for output fields, highlighting, filtering, sorting, grouping, and pagination.

```HTTP
GET /databases/{database_name}/tables/{table_name}/docs?output=["field1","field2"]&filter="name=John"&limit=10
```

--------------------------------

### Run a Vector Search using Infinity Python SDK

Source: https://infiniflow.org/docs/dev/deploy_infinity_server

Demonstrates how to connect to an Infinity server, create a database and table, insert data, and perform a vector similarity search. Requires the infinity-sdk to be installed and a running Infinity server.

```python
import infinity  

infinity_object = infinity.connect(infinity.NetworkAddress("<SERVER_IP_ADDRESS>", 23817))   
db_object = infinity_object.get_database("default_db")  
table_object = db_object.create_table("my_table", {"num": {"type": "integer"}, "body": {"type": "varchar"}, "vec": {"type": "vector, 4, float"}})
table_object.insert([{"num": 1, "body": "unnecessary and harmful", "vec": [1.0, 1.2, 0.8, 0.9]}])  
table_object.insert([{"num": 2, "body": "Office for Harmful Blooms", "vec": [4.0, 4.2, 4.3, 4.5]}])  
res = table_object.output(["*"])  
                  .match_dense("vec", [3.0, 2.8, 2.7, 3.1], "float", "ip", 2)  
                  .to_pl()  
print(res)  

```

--------------------------------

### Admin Show Node Variables Request Example (curl)

Source: https://infiniflow.org/docs/v0.5.2/http_api_reference

This example shows how to retrieve all node variables in admin mode using a GET request. The request targets the /admin/variables endpoint and requires an 'accept: application/json' header. A successful response (status code 200) returns a JSON object with an error code of 0 and the server's role.

```curl
curl --request GET \
    --url http://localhost:23821/admin/variables \
    --header 'accept: application/json'
```

--------------------------------

### Show Memory API Request Example (curl)

Source: https://infiniflow.org/docs/v0.5.2/http_api_reference

Illustrates how to query the memory usage information of the Infiniflow instance using curl. This is achieved via a GET request to the /instance/memory endpoint.

```bash
curl --request GET \
    --url http://localhost:23821/instance/memory \
    --header 'accept: application/json'
```

--------------------------------

### Show Object API Request Example (curl)

Source: https://infiniflow.org/docs/v0.5.2/http_api_reference

Demonstrates how to retrieve a specific persistence object by its name using a curl command. This involves a GET request to the /instance/objects/{object_name} endpoint.

```bash
curl --request GET \
    --url http://localhost:23820/instance/objects/{object_name} \
    --header 'accept: application/json'
```

--------------------------------

### Install GCC 15, LLVM 20, vcpkg, and jemalloc

Source: https://infiniflow.org/docs/dev/build_from_source

Installs GCC 15, LLVM 20 toolchain, vcpkg package manager, and jemalloc memory allocator. It also configures environment variables and updates system alternatives for compilers and linkers.

```shell
cd ~/Downloads
git clone https://github.com/microsoft/vcpkg.git
cd vcpkg && ./bootstrap-vcpkg.sh -disableMetrics
sh -c 'cat <<EOF >> ~/.bashrc  
export VCPKG_ROOT=${PWD}  
export PATH=${VCPKG_ROOT}:${PATH}  
EOF'
source ~/.bashrc
wget https://apt.llvm.org/llvm.sh && chmod +x llvm.sh && sudo ./llvm.sh 20 && rm llvm.sh
sudo add-apt-repository -P ppa:ubuntu-toolchain-r/test
sudo apt update && sudo apt install clang-tools-20 flex zlib1g-dev python3-dev autoconf
wget https://github.com/jemalloc/jemalloc/archive/refs/tags/5.3.0.tar.gz
tar zxvf 5.3.0.tar.gz && cd jemalloc-5.3.0 && ./autogen.sh && CFLAGS="-fPIC" CXXFLAGS="-fPIC" ./configure --enable-static --disable-libdl --enable-prof --enable-prof-libunwind --disable-initial-exec-tls && sudo make -j install && cd ..
sudo ldconfig && sudo rm -rf jemalloc-5.3.0 5.3.0.tar.gz
sudo ln -s /usr/lib/llvm-20/bin/clang-scan-deps /usr/bin/clang-scan-deps
sudo ln -s /usr/bin/clang-format-20 /usr/bin/clang-format
sudo ln -s /usr/bin/clang-tidy-20 /usr/bin/clang-tidy
sudo ln -s /usr/bin/llvm-symbolizer-20 /usr/bin/llvm-symbolizer
sudo ln -s /usr/lib/llvm-20/include/x86_64-pc-linux-gnu/c++/v1/__config_site /usr/lib/llvm-20/include/c++/v1/__config_site
```

--------------------------------

### Build and Run Infinity Server (Native)

Source: https://infiniflow.org/docs/v0.5.2/build_from_source

Builds the Infinity server and starts it without Docker. This is a prerequisite for running functional tests natively.

```bash
cmake -G Ninja -DCMAKE_BUILD_TYPE=Debug -DCMAKE_VERBOSE_MAKEFILE=ON ..  
cmake --build . -t infinity  
./cmake-build-debug/src/infinity  
```

--------------------------------

### Show Memory Object API Request Example (curl)

Source: https://infiniflow.org/docs/v0.5.2/http_api_reference

Demonstrates how to retrieve memory object usage information for the instance using a curl command. This involves a GET request to the /instance/memory/objects endpoint.

```bash
curl --request GET \
    --url http://localhost:23821/instance/memory/objects \
    --header 'accept: application/json'
```

--------------------------------

### Get Database Info Response Example (JSON)

Source: https://infiniflow.org/docs/v0.5.2/http_api_reference

This JSON object represents a successful response when retrieving information about a database. It includes an error code, the database name, its storage directory, and the number of tables it contains.

```json
{
    "error_code": 0,
    "database_name": "default_db",
    "storage_directory": "/var/infinity/data/nIHniKeHIB_db_default",
    "table_count": "4"
}
```

--------------------------------

### Download Benchmark Datasets

Source: https://infiniflow.org/docs/dev/benchmark

These commands download the SIFT1M and GIST1M benchmark datasets using wget. Ensure you have wget installed to use this functionality.

```bash
#download sift benchmark  
wget ftp://ftp.irisa.fr/local/texmex/corpus/sift.tar.gz  
#download gist benchmark  
wget ftp://ftp.irisa.fr/local/texmex/corpus/gist.tar.gz  
  

```
Tokens:
Raw