Struct QueryAnnotations 

pub struct QueryAnnotations { /* private fields */ }

Per-query annotation values that enrich OpenTelemetry spans with semantic-convention attributes the library cannot derive automatically (because it does not parse SQL).

Use the builder methods to set whichever attributes apply to a given query, then pass the result through one of the equivalent annotation surfaces:

• Executor-side – Pool::with_annotations, PoolConnection::with_annotations, or Transaction::with_annotations. Returns a borrowed wrapper that is itself an sqlx::Executor.
• Query-side – QueryAnnotateExt::with_annotations on the builder produced by sqlx::query, sqlx::query_as, sqlx::query_scalar, or their _! macro forms.

Both surfaces produce identical telemetry; pick whichever keeps the annotation closer to the thing it describes.

Example

use sqlx::Executor as _;
use sqlx_otel::QueryAnnotations;

pool.with_annotations(
    QueryAnnotations::new()
        .operation("SELECT")
        .collection("users"),
)
.fetch_all("SELECT * FROM users")
.await?;

Implementations

impl QueryAnnotations

pub fn new() -> Self

Create a new, empty set of annotations. All fields default to None.

pub fn operation(self, operation: impl Into<String>) -> Self

Set the db.operation.name attribute – the database operation being performed (e.g. "SELECT", "INSERT", "findAndModify").

The OpenTelemetry semantic conventions require this value to be low cardinality, since it is used to construct span names when query_summary is not set. Callers who cannot guarantee low cardinality should set query_summary instead – the library uses that path without a low-cardinality assumption.

pub fn collection(self, collection: impl Into<String>) -> Self

Set the db.collection.name attribute – the table or collection being operated on (e.g. "users", "orders").

pub fn query_summary(self, summary: impl Into<String>) -> Self

Set the db.query.summary attribute – a low-cardinality summary of the query (e.g. "SELECT users", "INSERT orders").

When set, this value also drives the span name (level 1 of the OpenTelemetry database span name hierarchy), overriding the {operation} {collection} synthesis. Cardinality control is the caller’s responsibility – a high-cardinality summary will produce high-cardinality span names.

pub fn stored_procedure(self, name: impl Into<String>) -> Self

Set the db.stored_procedure.name attribute – the name of a stored procedure being called (e.g. "get_user", "sp_update_orders").

Trait Implementations

impl Clone for QueryAnnotations

fn clone(&self) -> QueryAnnotations

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for QueryAnnotations

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for QueryAnnotations

fn default() -> QueryAnnotations

Returns the “default value” for a type.

impl PartialEq for QueryAnnotations

fn eq(&self, other: &QueryAnnotations) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for QueryAnnotations

impl StructuralPartialEq for QueryAnnotations