balderdashy / balderdashy/sails

Adpaters: Streaming Interface? Migratable Interface?

Open
#4,686 2 comments 0 reactions 0 assignees View on GitHub
docs helpful info or workaround needs documentation
Dominant language
JavaScript
Stars
22.8k
Forks
1.9k
PR merge metrics
No merged PRs in 30d

Description

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 :) )

Contributor guide

Open the contributing guide

Research direction

Start with contributing/adapter-specification.md and the documentation page listing supported adapters. Compare the documented Migratable interface with the interfaces supported by official adapters, and identify the missing Streaming interface. Done means the custom adapter documentation accurately describes both interfaces and their status for Sails 1.x.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js, sqlite
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.