Discussing the Functionality and Structure of Typesense Client Libraries

Essentially Typesense has a collection of REST API endpoints that you see in the sidebar here: https://typesense.org/docs/0.19.0/api/

Now, a dev could use any HTTP library in their language of choice to make HTTP calls to those API endpoints, but we're trying to make it easy for everyone to call these endpoints via method calls in their respective languages.

For eg: Instead of making an HTTP call like this to list all collections / indices and set headers:

curl -H "X-TYPESENSE-API-KEY: ${TYPESENSE_API_KEY}" ""

If you use the Python library, you can just call:

client.collections.retrieve()

So the client libraries are thin wrappers around the API and each of them follow similar method calls.

Here's an example of how the Python library can be used: https://github.com/typesense/typesense-python/blob/c0592c8936540397d436d92b634cc40005c42a69/examples/collection_operations.py

Here are all the classes we typically create in each client to support a consistent method invocation pattern across clients: https://github.com/typesense/typesense-python/tree/master/typesense

Most classes are pretty simple. The most complicated piece to port over is the retry logic, where if one Typesense node in a cluster is down, the client will detect it and retry the request to another node, for high availability:

https://github.com/typesense/typesense-python/blob/c0592c8936540397d436d92b634cc40005c42a69/typesense/api_call.py#L86-L129

Harpreet You can check this guidance !

Joe This is a good thread to read for guidance on client library architecture ^

Thanks, and yes it seems nice and performant that's for sure; I'm running it via docker in VirtualBox and port forwarding and still seems snappy; c++ will make you go gray though. The gitlab Java client has the bulk of the operations done, minus export/import, key management and possibly grouping operations on the search I think. My github issue seems to be getting worse, I can't reset password or create a new account, keep having to do a captcha on solving which set of dice add up to 14, but after solving 5, it goes to 10, after 10 to 15 etc. Very annoying hehe. It's possible that the code there though might be a start for others to look at, or hopefully at least grab bits of.