diff options
Diffstat (limited to 'doc/implementation.md')
| -rw-r--r-- | doc/implementation.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/implementation.md b/doc/implementation.md new file mode 100644 index 0000000..de46a9f --- /dev/null +++ b/doc/implementation.md @@ -0,0 +1,21 @@ +# q - Treating Text as a Database + +## Implementation + +The current implementation is written in Python using an in-memory database, in order to prevent the need for external dependencies. The implementation itself supports SELECT statements, including JOINs (Subqueries are supported only in the WHERE clause for now). + +Please note that there is currently no checks and bounds on data size - It's up to the user to make sure things don't get too big. + +Please make sure to read the limitations section as well. + +Code wise, I'm planning for a big refactoring, and I have added full test suite in the latest version, so it'll be easier to do properly. + +## Tests + +The code includes a test suite runnable through `test/test-all`. If you're planning on sending a pull request, I'd appreciate if you could make sure that it doesn't fail. Additional ideas related to testing are most welcome. + +## Contact +Any feedback/suggestions/complaints regarding this tool would be much appreciated. Contributions are most welcome as well, of course. + +Harel Ben-Attia, harelba@gmail.com, [@harelba](https://twitter.com/harelba) on Twitter + |