Skip to content

Update transaction and query options specifications for GRPC and HTTP #931

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

Merged
merged 2 commits into from
Apr 28, 2025

Conversation

farost
Copy link
Member

@farost farost commented Apr 17, 2025

Goal

Add transaction and query options specification for GRPC and HTTP.

Implementation

Update HTTP's answerCountLimit behavior for write queries to match the updated behavior in typedb/typedb#7437.

Add a new section in the server transactions manual describing transaction and query options.

Save descriptions and default values of the options in a separate resources folder to:

  • include them in asciidoc tables in the server transactions manual;
  • include them in asciidoc tables in the HTTP endpoint api reference;
  • copy them into the codegen comments in drivers.

@typedb-bot
Copy link
Member

typedb-bot commented Apr 17, 2025

PR Review Checklist

Do not edit the content of this comment. The PR reviewer should simply update this comment by ticking each review item below, as they get completed.


Trivial Change

  • This change is trivial and does not require a code or architecture review.

Code

  • Packages, classes, and methods have a single domain of responsibility.
  • Packages, classes, and methods are grouped into cohesive and consistent domain model.
  • The code is canonical and the minimum required to achieve the goal.
  • Modules, libraries, and APIs are easy to use, robust (foolproof and not errorprone), and tested.
  • Logic and naming has clear narrative that communicates the accurate intent and responsibility of each module (e.g. method, class, etc.).
  • The code is algorithmically efficient and scalable for the whole application.

Architecture

  • Any required refactoring is completed, and the architecture does not introduce technical debt incidentally.
  • Any required build and release automations are updated and/or implemented.
  • Any new components follows a consistent style with respect to the pre-existing codebase.
  • The architecture intuitively reflects the application domain, and is easy to understand.
  • The architecture has a well-defined hierarchy of encapsulated components.
  • The architecture is extensible and scalable.

@farost
Copy link
Member Author

farost commented Apr 17, 2025

This PR will be merged after the referenced changes are released.

@@ -4,7 +4,9 @@ The TypeDB HTTP endpoint can be used to perform database management, user manage

== Server configuration

TypeDB server by runs both a gRPC (standard for most of the client applications) and an HTTP endpoint by default. Both endpoints have common authentication and xref:{page-version}@manual::configure/encryption.adoc[encryption settings]. Additionally, it is possible to disable the HTTP endpoint and change its default port.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are many formatting updates. I will highlight what I actually changed

[NOTE]
====
This behaviour will be changed in the next stable version of TypeDB:
- Read queries will return `206 Partial Content` with all the answers processed;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is what I've changed

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

@farost farost changed the title Update HTTP's answerCountLimit behavior for write queries Update transaction and query options specifications for GRPC and HTTP Apr 25, 2025
@@ -171,3 +171,67 @@ HTTP::
Refer to xref:{page-version}@drivers::http/index.adoc#_run_queries[Running queries through HTTP endpoint].
--
====

[#_transaction_options]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do I need to put a note that it's available since 3.2.0 or smth?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not major enough i think

@farost farost merged commit f0ddbec into typedb:3.x-development Apr 28, 2025
@farost farost deleted the http-enhanced branch April 28, 2025 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants