Documentation: Add executable code examples

[amotl]

Hi there,

instead of only nurturing the cratedb-examples » by-language folder with executable and sensible code examples, which demonstrate and explore specific areas around communicating with CrateDB efficiently, I think it is also valuable to maintain corresponding examples folders within the repositories itself, because this is where developers very often will look for, just because, well, runnable code examples are just so incredibly useful, and where else should I expect to find them? ¹

In this spirit, this patch is adding two code example from my gists collection, sqlalchemy_efficient_inserts.py and cratedb_pandas_insert.py, which I think make sense to be added here. I don't think they necessarily have to be tested automatically, but sure it will be nice to have, so if you think they should be tested, I am sure we will find a way to add them to the test suite without too much obstruction on a subsequent iteration.

With kind regards,
Andreas.

P.S.: This patch is here to set the stage for a subsequent one, which refactors the performance-optimized insert_bulk function into the package itself, in order to be able to reuse it in downstream software, notebooks and tutorials more easily.

/cc @marijaselakovic, @hammerhead, @hlcianfagna, @proddata, @WalBeh

Footnotes

1. I found this has not been much of a guideline at CrateDB's auxilliary repositories yet, so I started that recently at CrateDB PDO driver » Examples. ↩

[matriv]

In my opinion we shouldn't duplicate work to each repo, I believe it's enough to have all examples in the cratedb-examples repo and link to them?

[amotl]

Hi @matriv,

your suggestion resonates well with me. Let's close this PR, and adjust GH-553 correspondingly.

With kind regards,
Andreas.

[amotl]

I believe it's enough to have all examples in the cratedb-examples repo and link to them?

crate/cratedb-examples#64 converges the content, and GH-554 adds corresponding pointers. Thanks!