Skip to content

Commit

Permalink
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
# All the missing SQLite functions

SQLite has few functions compared to other database management systems. SQLite authors see this as a feature rather than a problem, because SQLite has an extension mechanism in place. There are a lot of SQLite extensions out there, but they are incomplete, inconsistent and scattered across the internet.
SQLite has few functions compared to other database management systems. SQLite authors see this as a feature rather than a problem, because SQLite has an extension mechanism in place.

`sqlean` brings them together, neatly packaged into domain modules, documented, tested, and built for Linux, Windows and macOS.
There are a lot of SQLite extensions out there, but they are incomplete, inconsistent and scattered across the internet. `sqlean` brings them together, neatly packaged into domain modules, documented, tested, and built for Linux, Windows and macOS.

We do not try to combine all the existing extensions into one giant pile — that would not be very useful. The goal is to create a well-thought set of domain modules with a convenient API. A kind of standard library for SQLite.
We do not try to gather all the existing extensions into one giant pile — that would not be very useful. The goal is to create a well-thought set of domain modules with a convenient API. A kind of standard library for SQLite.

To achieve it, we split extensions that are too broad, merge the ones that are too narrow, refactor, add missing features, test, document, and do a ton of other small things.

## The main set

@@ -28,7 +30,7 @@ Think of them as of the extended standard library for SQLite:

## The incubator

These functions haven't yet made their way to the main extension set. They may be untested, poorly documented, and without a well-thought API. Think of them as of candidates for the standard library.
These extensions haven't yet made their way to the main set. They may be untested, poorly documented, too broad, too narrow, or without a well-thought API. Think of them as candidates for the standard library.

See the [full extension list](https://github.com/nalgeon/sqlean/issues/27) and vote for your favorites! We'll merge popular ones into the main set.

@@ -74,6 +76,15 @@ connection.close()

You can specify any other supported extension instead of `stats`.

## Contributing

Contributions are welcome! Submit your own or third-party extension to the incubator:

- [How to submit your extension](https://github.com/nalgeon/sqlean/blob/incubator/docs/submit.md)
- [How to submit a third-party extension](https://github.com/nalgeon/sqlean/blob/incubator/docs/external.md)

Please note that we accept only extensions with permissive licenses (MIT License, Apache License etc) or public domain. Copyleft licenses like GPL won't do.

## License

Copyright (c) 2021 [Anton Zhiyanov](https://antonz.org/), [Contributors](https://github.com/nalgeon/sqlean/graphs/contributors) and [Third-party Authors](docs/third-party.md).

0 comments on commit 1ac648e

Please sign in to comment.