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.

Sign up for GitHub

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

Jump to bottom

Document t_first as SUCCESS response. #65

Merged
merged 2 commits into from
Jul 2, 2024
Merged

Document t_first as SUCCESS response. #65

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ca39d92
Document `t_first` as `SUCCESS` response.
stefano-ottolenghi Jul 1, 2024
0813fbc
Update modules/ROOT/pages/bolt/message.adoc
stefano-ottolenghi Jul 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 34 additions & 26 deletions modules/ROOT/pages/bolt/message.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1256,25 +1256,29 @@ label:new[Introduced in bolt 4.0]

Or in the case that `has_more` is `false`:

** `bookmark::String`, the bookmark after committing this transaction (*Autocommit Transaction* only).
** `t_last::Integer`, the time, specified in ms, which the last record in the result stream is consumed after.
** `bookmark::String` -- the bookmark after committing this transaction (*Autocommit Transaction* only).
** `db::String` -- the database name where the query was executed.
label:new[Introduced in bolt 4.0]
** `notifications::List<Dictionary>` -- a list of all notifications generated during execution of this statement.
May be omitted if no notifications exist.
In *v3*, this field is `notifications::Dictionary`.
label:new[Introduced in bolt 3]
** `result_consumed_after::Integer`, same as `t_last`.
label:deprecated[Removed after bolt 2]
** `type::String`, the type of the statement, e.g. `"r"` for read-only statement, `"w"` for write-only statement, `"rw"` for read-and-write, and `"s"` for schema only.
** `plan::Dictionary` -- plan result.
label:new[Introduced in bolt 3]
** `profile::Dictionary` -- profile result.
label:new[Introduced in bolt 3]
** `stats::Dictionary`, counter information, such as db-hits etc.
** `result_consumed_after::Integer` -- same as `t_last`.
label:deprecated[Removed after bolt 2]
** `result_available_after::Integer` -- same as `t_first`.
label:deprecated[Removed after bolt 2]
** `stats::Dictionary` -- counter information, such as db-hits etc.
label:new[Introduced in bolt 3]
** `plan::Dictionary`, plan result.
** `t_last::Integer` -- the time (in ms) after which the last record in the result stream is consumed.
label:new[Introduced in bolt 3]
** `profile::Dictionary`, profile result.
** `t_first::Integer` -- the time (in ms) after which the DBMS was ready to stream the first record in the result.
label:new[Introduced in bolt 3]
** `notifications::List<Dictionary>`, a list of all notifications generated during execution of this statement.
May be omitted if no notifications exist.
In *v3*, this field is `notifications::Dictionary`.
** `type::String` -- the type of the statement, e.g. `"r"` for read-only statement, `"w"` for write-only statement, `"rw"` for read-and-write, and `"s"` for schema only.
label:new[Introduced in bolt 3]
** `db::String`, the database name where the query was executed.
label:new[Introduced in bolt 4.0]

.Example 1 *v4+*
[source, bolt]
Expand Down Expand Up @@ -1382,25 +1386,29 @@ If this field is not present it should be considered to default to `false`.

Or in the case that `has_more` is `false`:

** `bookmark::String`, the bookmark after committing this transaction (*Autocommit Transaction* only).
** `t_last::Integer`, the time, specified in ms, which the last record in the result stream is consumed after.
** `bookmark::String` -- the bookmark after committing this transaction (*Autocommit Transaction* only).
** `db::String` -- the database name where the query was executed.
label:new[Introduced in bolt 4.0]
** `notifications::List<Dictionary>` -- a list of all notifications generated during execution of this statement.
May be omitted if no notifications exist.
In *v3*, this field is `notifications::Dictionary`.
label:new[Introduced in bolt 3]
** `result_consumed_after::Integer`, same as `t_last`.
label:deprecated[Removed after bolt 2]
** `type::String`, the type of the statement, e.g. `"r"` for read-only statement, `"w"` for write-only statement, `"rw"` for read-and-write, and `"s"` for schema only.
** `plan::Dictionary` -- plan result.
label:new[Introduced in bolt 3]
** `profile::Dictionary` -- profile result.
label:new[Introduced in bolt 3]
** `stats::Dictionary`, counter information, such as db-hits etc.
** `result_consumed_after::Integer` -- same as `t_last`.
label:deprecated[Removed after bolt 2]
** `result_available_after::Integer` -- same as `t_first`.
label:deprecated[Removed after bolt 2]
** `stats::Dictionary` -- counter information, such as db-hits etc.
label:new[Introduced in bolt 3]
** `plan::Dictionary`, plan result.
** `t_last::Integer` -- the time (in ms) after which the last record in the result stream is consumed.
label:new[Introduced in bolt 3]
** `profile::Dictionary`, profile result.
** `t_first::Integer` -- the time (in ms) after which the first record in the result stream is available.
label:new[Introduced in bolt 3]
** `notifications::List<Dictionary>`, a list of all notifications generated during execution of this statement.
May be omitted if no notifications exist.
In *v3*, this field is `notifications::Dictionary`.
** `type::String` -- the type of the statement, e.g. `"r"` for read-only statement, `"w"` for write-only statement, `"rw"` for read-and-write, and `"s"` for schema only.
label:new[Introduced in bolt 3]
** `db::String`, the database name where the query was executed.
label:new[Introduced in bolt 4.0]

.Example
[source, bolt]
Expand Down
Loading