Documentation for Database Adapter Interface
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 6.5k
- Forks
- 456
- Avg merge
- 1d 5h
- Merged PRs (30d)
- 5
Description
From a discussion in https://github.com/share/sharedb/issues/131#issuecomment-346883867 , it would be useful to have at least brief documentation on the interface that a database backend adapter must implement, and why.
Currently, to implement a new database adapter, it looks like the only way is to somewhat blindly port the code from one of the existing adapters:
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked discussion in issue #131, then compare the existing sharedb-mongo, sharedb-mingo-memory, sharedb-postgres, and sharedb-mysql adapters. Document the database adapter interface, including why each part is required. Done means a developer can use the documentation to implement a new adapter without blindly porting an existing one.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100