typesense-website icon indicating copy to clipboard operation
typesense-website copied to clipboard

docs(collection): add warning about concurrent alter operations in v26.0

Open tharropoulos opened this issue 1 year ago • 3 comments

Change Summary

This change adds an important warning to the collections API documentation for Typesense v26.0. It informs users about a new restriction on concurrent alter operations, which was implemented to address client timeout issues.

  • Added a warning block to highlight a new limitation in v26.0

PR Checklist

tharropoulos avatar Jul 23 '24 08:07 tharropoulos

Starting with v26.0,

This is not needed because all our docs are versioned to that specific version.

This was enforced because clients were timing out on alter operations and retrying.

Change to:

"Since the alter operation can take a long time, this ensures that a client with a short default time-out does not end up retrying the same alter request."

kishorenc avatar Jul 23 '24 10:07 kishorenc

This is not needed because all our docs are versioned to that specific version.

Nested field support is mentioned as starting with v0.24 on the docs . Should I omit the version number then?

tharropoulos avatar Jul 23 '24 11:07 tharropoulos

Yeah that's probably not needed.

kishorenc avatar Jul 23 '24 16:07 kishorenc

Yeah that's probably not needed. Change to:

"Since the alter operation can take a long time, this ensures that a client with a short default time-out does not end up retrying the same alter request."

Both addressed in 7fa5480b3641cba70d1b6d1a3df2d9086969a62f

tharropoulos avatar Aug 01 '24 16:08 tharropoulos