Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ttiimmothy/sqlite-csharp

My Sqlite starts with CSharp
https://github.com/ttiimmothy/sqlite-csharp

csharp sqlite

Last synced: 6 days ago
JSON representation

My Sqlite starts with CSharp

Awesome Lists containing this project

README

        

[![progress-banner](https://backend.codecrafters.io/progress/sqlite/904f9c23-9eb0-4459-85b3-fa3f7dd4b6ad)](https://app.codecrafters.io/users/codecrafters-bot?r=2qF)

# Sqlite CSharp
[![ci](https://github.com/ttiimmothy/sqlite-csharp/actions/workflows/ci.yml/badge.svg)](https://github.com/ttiimmothy/sqlite-csharp/actions/workflows/ci.yml)

This is a starting point for C# solutions to the
["Build Your Own SQLite" Challenge](https://codecrafters.io/challenges/sqlite).

In this challenge, you'll build a barebones SQLite implementation that supports
basic SQL queries like `SELECT`. Along the way we'll learn about
[SQLite's file format](https://www.sqlite.org/fileformat.html), how indexed data
is
[stored in B-trees](https://jvns.ca/blog/2014/10/02/how-does-sqlite-work-part-2-btrees/)
and more.

**Note**: If you're viewing this repo on GitHub, head over to
[codecrafters.io](https://codecrafters.io) to try the challenge.

## Passing the first stage

The entry point for your SQLite implementation is in `src/Program.cs`. Study and
uncomment the relevant code, and push your changes to pass the first stage:

```sh
git add .
git commit -m "pass 1st stage" # any msg
git push origin master
```

Time to move on to the next stage!

## Stage 2 & beyond

Note: This section is for stages 2 and beyond.

1. Ensure you have `dotnet (6.0)` installed locally
2. Run `./your_sqlite3.sh` to run your program, which is implemented in
`src/Program.cs`.
3. Commit your changes and run `git push origin master` to submit your solution
to CodeCrafters. Test output will be streamed to your terminal.

## 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
[codecrafters-io/sample-sqlite-databases](https://github.com/codecrafters-io/sample-sqlite-databases).

## License

Sqlite CSharp is licensed under [GNU General Public License v3.0](LICENSE).