Package io.opentelemetry.instrumentation.api.incubator.semconv.db

Class SqlQuery

java.lang.Object

io.opentelemetry.instrumentation.api.incubator.semconv.db.SqlQuery

public abstract class SqlQuery
extends Object

Constructor Summary

Constructors

Constructor	Description
SqlQuery()

Method Summary

Modifier and Type	Method	Description
static SqlQuery	create(String queryText, String operationName, String target)	Creates a SqlQuery for old semconv (no querySummary).
static SqlQuery	createWithSummary(String queryText, String storedProcedureName, String querySummary)	Creates a SqlQuery for stable semconv (uses querySummary).
abstract String	getCollectionName()	Deprecated.
abstract String	getOperationName()	Deprecated.
abstract String	getQuerySummary()	Returns a low cardinality summary of the database query suitable for use as a span name or metric attribute.
abstract String	getQueryText()
abstract String	getStoredProcedureName()	Returns the stored procedure name for CALL operations, or null for other operations.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SqlQuery

public SqlQuery()

Method Details

createWithSummary

public static SqlQuery createWithSummary(@Nullable
 String queryText,
 @Nullable
 String storedProcedureName,
 @Nullable
 String querySummary)

Creates a SqlQuery for stable semconv (uses querySummary).

create

public static SqlQuery create(@Nullable
 String queryText,
 @Nullable
 String operationName,
 @Nullable
 String target)

Creates a SqlQuery for old semconv (no querySummary). Package-private for backward compatibility with old jflex-generated sanitizer.

getQueryText

@Nullable
public abstract String getQueryText()

getOperationName

@Nullable
@Deprecated
public abstract String getOperationName()

Deprecated.

getCollectionName

@Nullable
@Deprecated
public abstract String getCollectionName()

Deprecated.

Returns the table/collection name, or null for CALL operations.

See Also:

• getStoredProcedureName()

getStoredProcedureName

@Nullable
public abstract String getStoredProcedureName()

Returns the stored procedure name for CALL operations, or null for other operations.

getQuerySummary

@Nullable
public abstract String getQuerySummary()

Returns a low cardinality summary of the database query suitable for use as a span name or metric attribute.

The summary contains operations (e.g., SELECT, INSERT) and their targets (e.g., table names) in the order they appear in the query. For example:

• SELECT wuser_table
• INSERT shipping_details SELECT orders
• SELECT songs artists (multiple tables)

See Also:

• Generating a summary of the query