feat(singlestoredb): add SingleStoreDB backend

.gitignore

@@ -46,6 +46,7 @@ venv/
 ENV/
 env.bak/
 venv.bak/
+.env.local
 
 # OS generated files
 .directory

README.md

@@ -135,7 +135,7 @@ This allows you to combine the flexibility of Python with the scale and performa
 
 ## Backends
 
-Ibis supports nearly 20 backends:
+Ibis supports 20 backends:
 
 - [Apache DataFusion](https://ibis-project.org/backends/datafusion/)
 - [Apache Druid](https://ibis-project.org/backends/druid/)
@@ -151,6 +151,7 @@ Ibis supports nearly 20 backends:
 - [Polars](https://ibis-project.org/backends/polars/)
 - [PostgreSQL](https://ibis-project.org/backends/postgresql/)
 - [RisingWave](https://ibis-project.org/backends/risingwave/)
+- [SingleStoreDB](https://ibis-project.org/backends/singlestoredb/)
 - [SQL Server](https://ibis-project.org/backends/mssql/)
 - [SQLite](https://ibis-project.org/backends/sqlite/)
 - [Snowflake](https://ibis-project.org/backends/snowflake)

ci/schema/singlestoredb.sql

@@ -0,0 +1,134 @@
+DROP TABLE IF EXISTS diamonds;
+
+CREATE TABLE diamonds (
+    carat FLOAT,
+    cut TEXT,
+    color TEXT,
+    clarity TEXT,
+    depth FLOAT,
+    `table` FLOAT,
+    price BIGINT,
+    x FLOAT,
+    y FLOAT,
+    z FLOAT
+) DEFAULT CHARACTER SET = utf8;
+
+DROP TABLE IF EXISTS astronauts;
+
+CREATE TABLE astronauts (
+    `id` BIGINT,
+    `number` BIGINT,
+    `nationwide_number` BIGINT,
+    `name` TEXT,
+    `original_name` TEXT,
+    `sex` TEXT,
+    `year_of_birth` BIGINT,
+    `nationality` TEXT,
+    `military_civilian` TEXT,
+    `selection` TEXT,
+    `year_of_selection` BIGINT,
+    `mission_number` BIGINT,
+    `total_number_of_missions` BIGINT,
+    `occupation` TEXT,
+    `year_of_mission` BIGINT,
+    `mission_title` TEXT,
+    `ascend_shuttle` TEXT,
+    `in_orbit` TEXT,
+    `descend_shuttle` TEXT,
+    `hours_mission` FLOAT,
+    `total_hrs_sum` FLOAT,
+    `field21` BIGINT,
+    `eva_hrs_mission` FLOAT,
+    `total_eva_hrs` FLOAT
+);
+
+DROP TABLE IF EXISTS batting;
+
+CREATE TABLE batting (
+    `playerID` VARCHAR(255),
+    `yearID` BIGINT,
+    stint BIGINT,
+    `teamID` VARCHAR(7),
+    `lgID` VARCHAR(7),
+    `G` BIGINT,
+    `AB` BIGINT,
+    `R` BIGINT,
+    `H` BIGINT,
+    `X2B` BIGINT,
+    `X3B` BIGINT,
+    `HR` BIGINT,
+    `RBI` BIGINT,
+    `SB` BIGINT,
+    `CS` BIGINT,
+    `BB` BIGINT,
+    `SO` BIGINT,
+    `IBB` BIGINT NULL,
+    `HBP` BIGINT NULL,
+    `SH` BIGINT NULL,
+    `SF` BIGINT NULL,
+    `GIDP` BIGINT NULL
+) DEFAULT CHARACTER SET = utf8;
+
+DROP TABLE IF EXISTS awards_players;
+
+CREATE TABLE awards_players (
+    `playerID` VARCHAR(255),
+    `awardID` VARCHAR(255),
+    `yearID` BIGINT,
+    `lgID` VARCHAR(7),
+    tie VARCHAR(7),
+    notes VARCHAR(255)
+) DEFAULT CHARACTER SET = utf8;
+
+DROP TABLE IF EXISTS functional_alltypes;
+
+CREATE TABLE functional_alltypes (
+    id INTEGER,
+    bool_col BOOLEAN,
+    tinyint_col TINYINT,
+    smallint_col SMALLINT,
+    int_col INTEGER,
+    bigint_col BIGINT,
+    float_col FLOAT,
+    double_col DOUBLE,
+    date_string_col TEXT,
+    string_col TEXT,
+    timestamp_col DATETIME,
+    year INTEGER,
+    month INTEGER
+) DEFAULT CHARACTER SET = utf8;
+
+DROP TABLE IF EXISTS json_t;
+
+CREATE TABLE IF NOT EXISTS json_t (rowid BIGINT, js JSON);
+
+INSERT INTO json_t VALUES
+    (1, '{"a": [1,2,3,4], "b": 1}'),
+    (2, '{"a":null,"b":2}'),
+    (3, '{"a":"foo", "c":null}'),
+    (4, 'null'),
+    (5, '[42,47,55]'),
+    (6, '[]'),
+    (7, '"a"'),
+    (8, '""'),
+    (9, '"b"'),
+    (10, NULL),
+    (11, 'true'),
+    (12, 'false'),
+    (13, '42'),
+    (14, '37.37');
+
+DROP TABLE IF EXISTS win;
+
+CREATE TABLE win (g TEXT, x BIGINT NOT NULL, y BIGINT);
+INSERT INTO win VALUES
+    ('a', 0, 3),
+    ('a', 1, 2),
+    ('a', 2, 0),
+    ('a', 3, 1),
+    ('a', 4, 1);
+
+DROP TABLE IF EXISTS topk;
+
+CREATE TABLE topk (x BIGINT);
+INSERT INTO topk VALUES (1), (1), (NULL);

compose.yaml

@@ -40,6 +40,31 @@ services:
       - mysql:/data
       - $PWD/docker/mysql:/docker-entrypoint-initdb.d:ro
 
+  singlestoredb:
+    environment:
+      ROOT_PASSWORD: ibis_testing
+      SINGLESTORE_LICENSE: "" # Optional license key
+      SINGLESTOREDB_DATABASE: ibis_testing
+      SINGLESTOREDB_PASSWORD: ibis_testing
+      SINGLESTOREDB_USER: root
+      SINGLESTOREDB_PORT: 3307
+    healthcheck:
+      interval: 1s
+      retries: 20
+      test:
+        - CMD-SHELL
+        - sdb-admin query --host 127.0.0.1 --user root --password ibis_testing --port 3306 --sql 'select 1'
+    image: ghcr.io/singlestore-labs/singlestoredb-dev:0.2.65
+    ports:
+      - 3307:3306 # Use 3307 to avoid conflict with MySQL
+      - 9089:9000 # Data API (use 9089 to avoid conflicts)
+      # - 9088:8080 # SingleStore Studio UI (use 9088 to avoid conflicts)
+    networks:
+      - singlestoredb
+    volumes:
+      - singlestoredb:/data
+      - $PWD/docker/singlestoredb:/docker-entrypoint-initdb.d:ro
+
   postgres:
     environment:
       POSTGRES_PASSWORD: postgres
@@ -618,6 +643,7 @@ networks:
   mssql:
   clickhouse:
   postgres:
+  singlestoredb:
   trino:
   druid:
   oracle:
@@ -633,6 +659,7 @@ volumes:
   mysql:
   oracle:
   postgres:
+  singlestoredb:
   exasol:
   impala:
   risingwave:

docker/singlestoredb/init.sql

@@ -0,0 +1,43 @@
+-- SingleStoreDB initialization script for Ibis testing
+-- This script sets up the basic database and user for testing
+
+-- Create the testing database
+CREATE DATABASE IF NOT EXISTS ibis_testing;
+
+-- Use the testing database
+USE ibis_testing;
+
+-- Create a test user with appropriate permissions
+-- Note: SingleStoreDB uses MySQL-compatible user management
+CREATE USER IF NOT EXISTS 'ibis'@'%' IDENTIFIED BY 'ibis';
+GRANT ALL PRIVILEGES ON ibis_testing.* TO 'ibis'@'%';
+
+-- Create some basic test tables for validation
+CREATE TABLE IF NOT EXISTS simple_table (
+    id INT PRIMARY KEY,
+    name VARCHAR(100),
+    value DECIMAL(10,2)
+);
+
+-- Insert some test data
+INSERT IGNORE INTO simple_table VALUES
+    (1, 'test1', 100.50),
+    (2, 'test2', 200.75),
+    (3, 'test3', 300.25);
+
+-- Create a table demonstrating SingleStoreDB-specific types
+CREATE TABLE IF NOT EXISTS singlestore_types (
+    id INT PRIMARY KEY AUTO_INCREMENT,
+    json_data JSON,
+    binary_data BLOB,
+    geom_data GEOMETRY,
+    timestamp_col TIMESTAMP DEFAULT CURRENT_TIMESTAMP
+);
+
+-- Insert test data for SingleStoreDB types
+INSERT IGNORE INTO singlestore_types (json_data, binary_data, geom_data) VALUES
+    ('{"key": "value1", "number": 123}', UNHEX('48656C6C6F'), POINT(1, 1)),
+    ('{"key": "value2", "array": [1,2,3]}', UNHEX('576F726C64'), POINT(2, 2));
+
+-- Show that the initialization completed
+SELECT 'SingleStoreDB initialization completed successfully' AS status;

docs/_tabsets/install.qmd

@@ -23,6 +23,7 @@ backends = [
     {"name": "PostgreSQL", "module": "postgres"},
     {"name": "PySpark", "module": "pyspark"},
     {"name": "RisingWave", "module": "risingwave"},
+    {"name": "SingleStoreDB", "module": "singlestoredb"},
     {"name": "Snowflake", "module": "snowflake"},
     {"name": "SQLite", "module": "sqlite"},
     {"name": "Trino", "module": "trino"},

docs/backends/singlestoredb.qmd

@@ -0,0 +1,111 @@
+# SingleStoreDB
+
+[https://www.singlestore.com](https://www.singlestore.com)
+
+![](https://img.shields.io/badge/memtables-fallback-yellow?style=flat-square) ![](https://img.shields.io/badge/inputs-SingleStoreDB tables-blue?style=flat-square) ![](https://img.shields.io/badge/outputs-SingleStoreDB tables | CSV | pandas | Parquet | PyArrow-orange?style=flat-square)
+
+## Install
+
+Install Ibis and dependencies for the SingleStoreDB backend:
+
+::: {.panel-tabset}
+
+## `pip`
+
+Install with the `singlestoredb` extra:
+
+```{.bash}
+pip install 'ibis-framework[singlestoredb]'
+```
+
+And connect:
+
+```{.python}
+import ibis
+
+con = ibis.singlestoredb.connect()  # <1>
+```
+
+1. Adjust connection parameters as needed.
+
+## `conda`
+
+Install for SingleStoreDB:
+
+```{.bash}
+conda install -c conda-forge ibis-singlestoredb
+```
+
+And connect:
+
+```{.python}
+import ibis
+
+con = ibis.singlestoredb.connect()  # <1>
+```
+
+1. Adjust connection parameters as needed.
+
+## `mamba`
+
+Install for SingleStoreDB:
+
+```{.bash}
+mamba install -c conda-forge ibis-singlestoredb
+```
+
+And connect:
+
+```{.python}
+import ibis
+
+con = ibis.singlestoredb.connect()  # <1>
+```
+
+1. Adjust connection parameters as needed.
+
+:::
+
+## Connect
+
+### `ibis.singlestoredb.connect`
+
+```python
+con = ibis.singlestoredb.connect(
+    user="username",
+    password="password",
+    host="hostname",
+    port=3306,
+    database="database",
+)
+```
+
+::: {.callout-note}
+`ibis.singlestoredb.connect` is a thin wrapper around [`ibis.backends.singlestoredb.Backend.do_connect`](#ibis.backends.singlestoredb.Backend.do_connect).
+:::
+
+### Connection Parameters
+
+```{python}
+#| echo: false
+#| output: asis
+from _utils import render_do_connect
+
+render_do_connect("singlestoredb")
+```
+
+### `ibis.connect` URL format
+
+In addition to `ibis.singlestoredb.connect`, you can also connect to SingleStoreDB by
+passing a properly-formatted SingleStoreDB connection URL to `ibis.connect`:
+
+```python
+con = ibis.connect(f"singlestoredb://{user}:{password}@{host}:{port}/{database}")
+```
+
+```{python}
+#| echo: false
+BACKEND = "SingleStoreDB"
+```
+
+{{< include ./_templates/api.qmd >}}

docs/backends_sankey.py

@@ -38,6 +38,7 @@ def to_greyish(hex_code, grey_value=128):
         "PostgreSQL",
         "PySpark",
         "RisingWave",
+        "SingleStoreDB",
         "Snowflake",
         "SQLite",
         "Theseus",