diff --git a/COMPAT.md b/COMPAT.md index 658c9b0e..9af20074 100644 --- a/COMPAT.md +++ b/COMPAT.md @@ -1,10 +1,10 @@ -# Limbo compatibility with SQLite +# Turso compatibility with SQLite -This document describes the compatibility of Limbo with SQLite. +This document describes the compatibility of Turso with SQLite. ## Table of contents -- [Limbo compatibility with SQLite](#limbo-compatibility-with-sqlite) +- [Turso compatibility with SQLite](#limbo-compatibility-with-sqlite) - [Table of contents](#table-of-contents) - [Overview](#overview) - [Features](#features) @@ -30,7 +30,7 @@ This document describes the compatibility of Limbo with SQLite. ## Overview -Limbo aims to be fully compatible with SQLite, with opt-in features not supported by SQLite. +Turso aims to be fully compatible with SQLite, with opt-in features not supported by SQLite. ### Features @@ -595,11 +595,11 @@ Therefore, all rollback-type modes (delete, truncate, persist, memory) are marke ## Extensions -Limbo has in-tree extensions. +Turso has in-tree extensions. ### UUID -UUID's in Limbo are `blobs` by default. +UUID's in Turso are `blobs` by default. | Function | Status | Comment | |-----------------------|--------|---------------------------------------------------------------| diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 47428698..a812df7f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,12 +1,12 @@ -# Contributing to Limbo +# Contributing to Turso -We'd love to have you contribute to Limbo! +We'd love to have you contribute to Turso! This document is a quick helper to get you going. ## Getting Started -Limbo is a rewrite of SQLite in Rust. If you are new to SQLite, the following articles and books are a good starting point: +Turso is a rewrite of SQLite in Rust. If you are new to SQLite, the following articles and books are a good starting point: * [Architecture of SQLite](https://www.sqlite.org/arch.html) * Sibsankar Haldar. [SQLite Database System Design and Implementation (2nd Edition)](https://books.google.fi/books/?id=yWzwCwAAQBAJ&redir_esc=y). 2016 @@ -117,7 +117,7 @@ For a longer discussion on good commits, see Al Tenhundfeld's [What makes a good ## Debugging query execution -Limbo aims towards SQLite compatibility. If you find a query that has different behavior than SQLite, the first step is to check what the generated bytecode looks like. +Turso aims towards SQLite compatibility. If you find a query that has different behavior than SQLite, the first step is to check what the generated bytecode looks like. To do that, first run the `EXPLAIN` command in `sqlite3` shell: @@ -136,7 +136,7 @@ addr opcode p1 p2 p3 p4 p5 comment 8 Goto 0 1 0 0 ``` -and then run the same command in Limbo's shell. +and then run the same command in Turso's shell. If the bytecode is different, that's the bug -- work towards fixing code generation. If the bytecode is the same, but query results are different, then the bug is somewhere in the virtual machine interpreter or storage layer. @@ -144,7 +144,7 @@ If the bytecode is the same, but query results are different, then the bug is so ## Compatibility tests The `testing/test.all` is a starting point for adding functional tests using a similar syntax to SQLite. -The purpose of these tests is to verify behavior matches with SQLite and Limbo. +The purpose of these tests is to verify behavior matches with SQLite and Turso. ### Prerequisites @@ -162,7 +162,7 @@ choco install sqlite ``` ### Running the tests -To run the test suite with Limbo, simply run: +To run the test suite with Turso, simply run: ``` make test @@ -178,7 +178,7 @@ When working on a new feature, please consider adding a test case for it. ## TPC-H -[TPC-H](https://www.tpc.org/tpch/) is a standard benchmark for testing database performance. To try out Limbo's performance against a TPC-H compatible workload, +[TPC-H](https://www.tpc.org/tpch/) is a standard benchmark for testing database performance. To try out Turso's performance against a TPC-H compatible workload, you can generate or download a TPC-H compatible SQLite database e.g. [here](https://github.com/lovasoa/TPCH-sqlite). ## Deterministic simulation tests @@ -190,7 +190,7 @@ The simulator also performs fault injection to discover interesting bugs. ## Python Bindings -Limbo provides Python bindings built on top of the [PyO3](https://pyo3.rs) project. +Turso provides Python bindings built on top of the [PyO3](https://pyo3.rs) project. To compile the Python bindings locally, you first need to create and activate a Python virtual environment (for example, with Python `3.12`): ```bash @@ -213,7 +213,7 @@ cd bindings/python && maturin develop ## Antithesis Antithesis is a testing platform for finding bugs with reproducibility. In -Limbo, we use Antithesis in addition to our own deterministic simulation +Turso, we use Antithesis in addition to our own deterministic simulation testing (DST) tool for the following: - Discovering bugs that the DST did not catch (and improve the DST) diff --git a/LICENSE.md b/LICENSE.md index d3ddb09d..9573cada 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ MIT License -Copyright 2024 the Limbo authors +Copyright 2024 the Turso authors Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in diff --git a/NOTICE.md b/NOTICE.md index 5c6e843f..c4e6fed2 100644 --- a/NOTICE.md +++ b/NOTICE.md @@ -3,7 +3,7 @@ Limbo Please visit our GitHub for more information: -* https://github.com/tursodatabase/limbo +* https://github.com/tursodatabase/turso Dependencies ============ diff --git a/PERF.md b/PERF.md index 0eda689e..7df1d35a 100644 --- a/PERF.md +++ b/PERF.md @@ -2,13 +2,13 @@ ## Mobibench -1. Clone the source repository of Mobibench fork for Limbo: +1. Clone the source repository of Mobibench fork for Turso: ```console git clone git@github.com:penberg/Mobibench.git ``` -2. Change `LIBS` in `shell/Makefile` to point to your Limbo source repository. +2. Change `LIBS` in `shell/Makefile` to point to your Turso source repository. 3. Build Mobibench: @@ -30,8 +30,8 @@ We have a modified version of the Clickbench benchmark script that can be run wi make clickbench ``` -This will build Limbo in release mode, create a database, and run the benchmarks with a small subset of the Clickbench dataset. -It will run the queries for both Limbo and SQLite, and print the results. +This will build Turso in release mode, create a database, and run the benchmarks with a small subset of the Clickbench dataset. +It will run the queries for both Turso and SQLite, and print the results. diff --git a/README.md b/README.md index 5bbb239a..892b69bf 100644 --- a/README.md +++ b/README.md @@ -42,16 +42,16 @@ In the future, we will be also working on: ## Getting Started -Please see the [Limbo Database Manual](docs/manual.md) for more information. +Please see the [Turso Database Manual](docs/manual.md) for more information.
💻 Command Line
-You can install the latest `limbo` release with: +You can install the latest `turso` release with: ```shell curl --proto '=https' --tlsv1.2 -LsSf \ - https://github.com/tursodatabase/limbo/releases/latest/download/turso_cli-installer.sh | sh + https://github.com/tursodatabase/turso/releases/latest/download/turso_cli-installer.sh | sh ``` Then launch the shell to execute SQL statements: @@ -61,10 +61,10 @@ Turso Enter ".help" for usage hints. Connected to a transient in-memory database. Use ".open FILENAME" to reopen on a persistent database -limbo> CREATE TABLE users (id INT PRIMARY KEY, username TEXT); -limbo> INSERT INTO users VALUES (1, 'alice'); -limbo> INSERT INTO users VALUES (2, 'bob'); -limbo> SELECT * FROM users; +turso> CREATE TABLE users (id INT PRIMARY KEY, username TEXT); +turso> INSERT INTO users VALUES (1, 'alice'); +turso> INSERT INTO users VALUES (2, 'bob'); +turso> SELECT * FROM users; 1|alice 2|bob ``` @@ -139,7 +139,7 @@ print(res.fetchone())
1. Clone the repository -2. Build the library and set your LD_LIBRARY_PATH to include limbo's target directory +2. Build the library and set your LD_LIBRARY_PATH to include turso's target directory ```console cargo build --package limbo-go export LD_LIBRARY_PATH=/path/to/limbo/target/debug:$LD_LIBRARY_PATH @@ -147,15 +147,15 @@ export LD_LIBRARY_PATH=/path/to/limbo/target/debug:$LD_LIBRARY_PATH 3. Use the driver ```console -go get github.com/tursodatabase/limbo -go install github.com/tursodatabase/limbo +go get github.com/tursodatabase/turso +go install github.com/tursodatabase/turso ``` Example usage: ```go import ( "database/sql" - _ "github.com/tursodatabase/limbo" + _ "github.com/tursodatabase/turso" ) conn, _ = sql.Open("sqlite3", "sqlite.db") @@ -219,7 +219,7 @@ terms or conditions. ## Partners -Thanks to all the partners of Limbo! +Thanks to all the partners of Turso!