balderdashy / sails

Realtime MVC Framework for Node.js
https://sailsjs.com
MIT License
22.82k stars 1.95k forks source link

Adpaters: Streaming Interface? Migratable Interface? #4686

Open kcappieg opened 5 years ago

kcappieg commented 5 years ago

I'm trying to see if I can get a sqlite adapter working with sails 1.x. I've forked https://github.com/AndrewJo/sails-sqlite3 which has a pretty good base of the Semantic and Queryable interfaces, but I wanted to extend it a little and make any changes needed to work in 1.x. (Specifically to implement Migratable.)

However the documentation on Custom Adapters is very confusing right now. The Migratable interface documentation at https://github.com/balderdashy/sails-docs/blob/master/contributing/adapter-specification.md is listed as the "Experimental" status, and there is no Streaming interface in those docs. The only reason I know a Streaming interface exists is because the docs page listing supported Adapters shows that most of the official ones support streaming.

Instead of me trying to guess from many different sources, could you update the documentation on Adapter interfaces?

(BTW, love sails. Keep up the good work! But don't forget documentation :) )

raqem commented 5 years ago

Hi @kcappieg, Thanks for the love! We will add this to our list of docs to revisit when we have time for updates.

raqem commented 5 years ago

Hi @kcappieg, Just wanted to let you know we are consolidating all of Sails issues into one repo. ~Cheers