Documentation

[plopidou]

🆕 If feature request

• User story: Start from scratch on a small side-project to potentially use on a (much) larger one. Real-time data crunching and visualising (nothing out of the ordinary...)
• Specific requirements/functionality: a thorough update/creation of the documentation. "Install with npm install @mapd/connector. Then import @mapd/connector in your JavaScript program." is far from sufficient.
• Mocks (if applicable):

Hi,

I hope you are all well in these somewhat troubled times!

Long story short: I have started having a close look at Omnisci. But very quickly hit a wall due an almost complete lack of documentation:

Install with npm install @mapd/connector. Then import @mapd/connector in your JavaScript program.

Is a little bit lacking, no? :-)

Also, the API documentation (using 5.2.0) that I could find here seems complete, but is missing many example of use. For example: https://omnisci.github.io/mapd-connector/docs/#importtableasync contains only:

importTableAsync

Following the link https://omnisci.github.io/mapd-connector/docs/#tcopyparams, TCopyParams seems to be documented, but how to import/require the function/class from a node script/project?
Ho! "See detectColumnTypes for a usage example.". Click, go to https://omnisci.github.io/mapd-connector/docs/detectColumnTypes. 404.

I hope you do not find this feature request unreasonable. Please do let me know if I have missed node-based examples/tutorials and/or howtos.

Thanks!