Documentation for Database Adapter Interface

share / sharedb

Realtime database backend based on Operational Transformation (OT)

Other

6.21k stars 450 forks source link

Documentation for Database Adapter Interface #183

Open curran opened 6 years ago

curran commented 6 years ago

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:

sharedb-mongo
sharedb-mingo-memory
sharedb-postgres
sharedb-mysql

WinMinTun commented 6 years ago

One more DB adapter for Redis, you can check my library https://github.com/WinMinTun/sharedb-redis . It has also persistence option. I believe it is quite stable, feel free to let me know anything.