Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: add a list of API changes from 0.7 to 0.8 #55

Open
2 tasks done
krisangle opened this issue Mar 5, 2024 · 1 comment
Open
2 tasks done

Documentation: add a list of API changes from 0.7 to 0.8 #55

krisangle opened this issue Mar 5, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@krisangle
Copy link

Description

It seems there are some breaking changes between the V0.8 and V0.7 of the surrealdb.wasm lib:

  • the 'use()' method now needs 'namespace' and 'database' instead of 'ns' and 'db'
  • the 'query()' method now always returns the results encaspsulated within an array even if there was a single result set (before, if the query was designed as returning a single result set, it would come directly as an array of values in the javascript response)

More generally, it would be appreciated to list the features/changes between versions of this wasm library. It would also be nice to cite which version of the surrealdb engine the wasm library is built on, as some SQL language features might not be available. Last suggestion: the documentation is lacking the structure of the returned values when calling the API.

Finally, the examples are lacking on how to use the library either as clientside-memory or with indexdb persistence. I could pick-up some tricks from some youtube video tutorials, but a bit tough to reach.

I believe this product is great, keep going guys!

Is there an existing issue for this?

  • I have searched the existing issues

Code of Conduct

  • I agree to follow this project's Code of Conduct
@krisangle krisangle added the documentation Improvements or additions to documentation label Mar 5, 2024
@limcheekin
Copy link

Thanks for created the issue.

As the creator of the surrealdb_wasm flutter package which depends on the surrealdb.wasm, I can't agreed more the changes of the API need to be well-documented.

Otherwise, it is like let the user flying in the dark.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants