Skip to main content

QueryTextMode

Enum QueryTextMode 

Source
pub enum QueryTextMode {
    Full,
    Obfuscated,
    Off,
}
Expand description

Controls whether and how db.query.text is captured on spans.

Configured via PoolBuilder::with_query_text_mode.

§Whitespace normalisation

For both Full and Obfuscated the emitted text has inter-token whitespace runs collapsed to a single ASCII space and leading/trailing whitespace trimmed. Whitespace inside string literals, quoted identifiers, dollar-quoted bodies, and comments is preserved verbatim. Multi-line SQL written across several Rust source lines therefore renders as a single readable line in OTel exports without the embedded \n and indentation runs that come from source-level formatting. Off is unaffected (no attribute is emitted).

§When to choose what

  • Full (default) – appropriate when all SQL flows through SQLx bind parameters. The captured text contains placeholders ($1, ?), not literal values, so user data does not leak into the span.
  • Obfuscated – appropriate when SQL is built via string interpolation (format!, query concatenation, dynamic identifiers) and may contain literal values. Structure is preserved; literals (string, numeric, hex, boolean, and PostgreSQL dollar-quoted) are replaced with ?. Comments, identifiers (quoted or otherwise), operators, and NULL are kept verbatim.
  • Off – appropriate when the query text is itself sensitive (proprietary schemas, query shapes that reveal business logic) or when query-text cardinality must be eliminated entirely.

db.query.parameter.<key> capture is not supportedSQLx’s Execute trait does not expose bind values, and reverse-engineering them from the encoded buffer would tie the wrapper to driver internals. Callers who need per-parameter attributes can add them manually via the active span using the OpenTelemetry API.

Variants§

§

Full

Capture the parameterised query text. This is the default because SQLx queries use bind parameters ($1, ?), so literal values are not present in the query string. Inter-token whitespace is collapsed to a single space and leading/trailing whitespace is trimmed; whitespace inside literals, identifiers, and comments is preserved verbatim.

§

Obfuscated

Replace literal values in the query text with ?. Useful when queries are built via string interpolation rather than bind parameters. The same whitespace normalisation as Full is applied after redaction.

§

Off

Do not capture db.query.text at all.

Trait Implementations§

Source§

impl Clone for QueryTextMode

Source§

fn clone(&self) -> QueryTextMode

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for QueryTextMode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for QueryTextMode

Source§

fn default() -> QueryTextMode

Returns the “default value” for a type. Read more
Source§

impl PartialEq for QueryTextMode

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Copy for QueryTextMode

Source§

impl Eq for QueryTextMode

Source§

impl StructuralPartialEq for QueryTextMode

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more