https://github.com/ivanbgd/sqlite-client-rust
SQLite client
https://github.com/ivanbgd/sqlite-client-rust
sqlite sqlite-client sqlite-database sqlite3 sqlite3-database
Last synced: 3 months ago
JSON representation
SQLite client
- Host: GitHub
- URL: https://github.com/ivanbgd/sqlite-client-rust
- Owner: ivanbgd
- License: mit
- Created: 2025-04-09T00:45:21.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-04-09T01:11:56.000Z (9 months ago)
- Last Synced: 2025-07-20T22:16:14.670Z (6 months ago)
- Topics: sqlite, sqlite-client, sqlite-database, sqlite3, sqlite3-database
- Language: Rust
- Homepage:
- Size: 85 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SQLite Client
# Sample Databases
To make it easy to test queries locally, we've added a sample database in the
root of this repository: `sample.db`.
This contains two tables: `apples` & `oranges`. You can use this to test your
implementation for the first 6 stages.
You can explore this database by running queries against it like this:
```sh
$ sqlite3 sample.db "select id, name from apples"
1|Granny Smith
2|Fuji
3|Honeycrisp
4|Golden Delicious
```
There are two other databases that you can use:
1. `superheroes.db`:
- This is a small version of the test database used in the table-scan stage.
- It contains one table: `superheroes`.
- It is ~1MB in size.
2. `companies.db`:
- This is a small version of the test database used in the index-scan stage.
- It contains one table: `companies`, and one index: `idx_companies_country`
- It is ~7MB in size.
These aren't included in the repository because they're large in size. You can
download them by running this script:
```sh
./download_sample_databases.sh
```
If the script doesn't work for some reason, you can download the databases
directly from [here](https://github.com/codecrafters-io/sample-sqlite-databases).
# Running the Program
The program works from the command line, and supports the so-called dot-commands (CLI commands) as well as
SQL commands.
Supported SQL commands can be supplied in lower, upper or mixed-case, i.e., they are case-insensitive.
The same is true of the supplied table and column names.
Values in the `WHERE` clause are case-sensitive.
Supported dot-commands are also case-insensitive.
## CLI Commands (dot-commands)
- To emulate `$ sqlite3 sample.db .dbinfo`:
```shell
$ ./run.sh sample.db .dbinfo
database page size: 4096
number of pages: 4
number of tables: 3
text encoding: utf-8
```
- To emulate `$ sqlite3 sample.db .tables`:
```shell
$ ./run.sh sample.db .tables
apples oranges
```
- To emulate `$ sqlite3 companies.db .index` or `$ sqlite3 companies.db .indexes`:
```shell
$ ./run.sh companies.db .index
$ ./run.sh companies.db .indexes
idx_companies_country
```
## SQL Commands
### Count number of rows in a table
```shell
$ ./run.sh sample.db "SELECT COUNT(*) FROM apples"
4
```
### Select from a single column
```shell
$ ./run.sh sample.db "SELECT name FROM apples"
Granny Smith
Fuji
Honeycrisp
Golden Delicious
```
Additionally, `LIMIT` is supported.
```shell
$ ./run.sh sample.db "SELECT name FROM apples LIMIT 3"
Granny Smith
Fuji
Honeycrisp
```
### Select from multiple columns
```shell
$ ./run.sh sample.db "SELECT name, color FROM apples"
Granny Smith|Light Green
Fuji|Red
Honeycrisp|Blush Red
Golden Delicious|Yellow
```
```shell
$ ./run.sh sample.db "SELECT * FROM apples"
1|Granny Smith|Light Green
2|Fuji|Red
3|Honeycrisp|Blush Red
4|Golden Delicious|Yellow
```
Additionally, `LIMIT` is supported.
```shell
$ ./run.sh sample.db "SELECT id, name, color FROM apples LIMIT 10"
1|Granny Smith|Light Green
2|Fuji|Red
3|Honeycrisp|Blush Red
4|Golden Delicious|Yellow
```
### Select Using Where
```shell
$ ./run.sh sample.db "SELECT id, name, color FROM apples WHERE color = 'Blush Red'"
3|Honeycrisp|Blush Red
```
Additionally, `LIMIT` is supported.
```shell
$ ./run.sh sample.db "SELECT id, name, color FROM apples WHERE color = 'Blush Red' LIMIT 1"
3|Honeycrisp|Blush Red
```
### Large Databases and Tables
Large tables, spanning multiple pages, are supported.
```shell
$ ./run.sh superheroes.db "SELECT id, name FROM superheroes WHERE eye_color = 'Pink Eyes'"
297|Stealth (New Earth)
790|Tobias Whale (New Earth)
1085|Felicity (New Earth)
2729|Thrust (New Earth)
3289|Angora Lapin (New Earth)
3913|Matris Ater Clementia (New Earth)
```
### Indexes
Indexes are also supported.
Rather than reading all rows in a table and then filtering in-memory,
we use an index to perform a more intelligent search.
To test whether our implementation actually uses an index, their tester uses a database that is ~1GB in size
and expects our program to return query results in less than 3 seconds.
The test database contains a `companies` table with an index named `idx_companies_country` on the `country` column.
We can download a small version of the `companies` database to test locally.
```shell
$ ./run.sh companies.db "SELECT id, name FROM companies WHERE country = 'eritrea'"
121311|unilink s.c.
2102438|orange asmara it solutions
5729848|zara mining share company
6634629|asmara rental
```
We can assume that all queries run by the tester will include `country` in the `WHERE` clause,
so they can be served by the index.
The tester will run multiple randomized queries and expect all of them to return results in under 3 seconds.
Since the table `superheroes` is smaller than `companies`, we can add an index to it and also work with it.
```shell
$ sqlite3 superheroes.db "CREATE INDEX idx_superheroes_eye_color on superheroes (eye_color)"
$ ./run.sh superheroes.db "SELECT id, name FROM superheroes LIMIT 10"
$ ./run.sh superheroes.db "SELECT id, name FROM superheroes WHERE eye_color = 'Pink Eyes' LIMIT 3"
```
# Additional Notes
## The Companies Database
The local (smaller) version of the `Companies` database can be used for testing of use of index that exists
on the `Country` column of the `Companies` table.
The file "test_dbs/countries_by_count_desc.txt" contains all countries and their counts sorted by count
in descending order. It was obtained with:
```shell
$ sqlite3 test_dbs/companies.db "SELECT country, COUNT(*) FROM companies GROUP BY country ORDER BY COUNT(*) DESC" > test_dbs/countries_by_count_desc.txt
```
The file "test_dbs/countries_by_country.txt" contains all countries and their counts sorted by country name.
It was obtained with:
```shell
$ sqlite3 test_dbs/companies.db "SELECT country, COUNT(*) FROM companies GROUP BY country ORDER BY country" > test_dbs/countries_by_country.txt
```