orientjs icon indicating copy to clipboard operation
orientjs copied to clipboard

Docs: Server/Database or Client/Session?

Open ghost opened this issue 7 years ago • 2 comments

I'm a little confused about which APIs are currently recommended for use.

The current docs, 3.0, have docs that recommend using the Client and Session objects for connecting to and working with Orient:

OrientDBClient.connect({ host: "localhost", port: 2424 }).then(client => client.session(...))

The v3.0 docs also only document a Client API and a Session API. They appear to drop the Record, Class, Index, and Function APIs (even though those continue to work in v3.0, even when using Sessions.)

The docs for v2.2, and well as the current Beta docs for v3.1, document Server, Database, Record, Class, etc. (However, the main page at v3.1 uses 3.0's Quick Start guide using Client and Sessions.)

Are Record, Class etc. deprecated? (I hope not, I quite like the Record API.) Are Server and Database replaced by Client and Session, and therefore deprecated?

ghost avatar Nov 14 '18 18:11 ghost

Hi @milaniliev

Record, Class are not deprecated since Session is an extension of the old Database with new behaviour. There are some docs missing of this api with new Session one. I'm working on this

wolf4ood avatar Nov 16 '18 13:11 wolf4ood

That's great news, thanks!

ghost avatar Nov 17 '18 19:11 ghost