Package org.eclipse.rdf4j.benchmark.common.plan

Class QueryPlanCapture

java.lang.Object

org.eclipse.rdf4j.benchmark.common.plan.QueryPlanCapture

@Experimental
public final class QueryPlanCapture
extends Object

Captures unoptimized/optimized/executed query explanations and persists snapshot artifacts.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_OUTPUT_DIRECTORY
static final String	ENABLE_CAPTURE_PROPERTY
static final String	FEATURE_PROPERTIES_PROPERTY
static final String	FEATURE_PROPERTY_PREFIX_PROPERTY
static final String	FORMAT_VERSION
static final String	GIT_BRANCH_PROPERTY
static final String	GIT_COMMIT_PROPERTY

Constructor Summary

Constructors

Constructor	Description
QueryPlanCapture()

Method Summary

Modifier and Type	Method	Description
QueryPlanSnapshot	capture(QueryPlanCaptureContext context, Supplier<? extends TupleQuery> tupleQuerySupplier)
Path	captureAndWrite(QueryPlanCaptureContext context, Supplier<? extends TupleQuery> tupleQuerySupplier)
static Map<String,String>	extractDebugMetrics(String explanationJson)
Optional<Path>	findByUnoptimizedFingerprint(Path directory, String unoptimizedFingerprint)
static boolean	isCaptureEnabled()
static Map<String,String>	metadataFromSystemProperties()
QueryPlanSnapshot	readSnapshot(Path inputFile)
static void	registerConfiguredFeatureFlags(FeatureFlagCollector collector)
static Path	resolveOutputDirectory()
void	writeSnapshot(Path outputFile, QueryPlanSnapshot snapshot)

Methods inherited from class java.lang.Object

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

Field Details

FORMAT_VERSION

public static final String FORMAT_VERSION

See Also:

• Constant Field Values

DEFAULT_OUTPUT_DIRECTORY

public static final String DEFAULT_OUTPUT_DIRECTORY

See Also:

• Constant Field Values

ENABLE_CAPTURE_PROPERTY

public static final String ENABLE_CAPTURE_PROPERTY

See Also:

• Constant Field Values

FEATURE_PROPERTIES_PROPERTY

public static final String FEATURE_PROPERTIES_PROPERTY

See Also:

• Constant Field Values

FEATURE_PROPERTY_PREFIX_PROPERTY

public static final String FEATURE_PROPERTY_PREFIX_PROPERTY

See Also:

• Constant Field Values

GIT_COMMIT_PROPERTY

public static final String GIT_COMMIT_PROPERTY

See Also:

• Constant Field Values

GIT_BRANCH_PROPERTY

public static final String GIT_BRANCH_PROPERTY

See Also:

• Constant Field Values

Constructor Details

QueryPlanCapture

public QueryPlanCapture()

Method Details

isCaptureEnabled

public static boolean isCaptureEnabled()

resolveOutputDirectory

public static Path resolveOutputDirectory()

metadataFromSystemProperties

public static Map<String,String> metadataFromSystemProperties()

registerConfiguredFeatureFlags

public static void registerConfiguredFeatureFlags(FeatureFlagCollector collector)

capture

public QueryPlanSnapshot capture(QueryPlanCaptureContext context,
 Supplier<? extends TupleQuery> tupleQuerySupplier)

captureAndWrite

public Path captureAndWrite(QueryPlanCaptureContext context,
 Supplier<? extends TupleQuery> tupleQuerySupplier)
                     throws IOException

Throws:

IOException

writeSnapshot

public void writeSnapshot(Path outputFile,
 QueryPlanSnapshot snapshot)
                   throws IOException

Throws:

IOException

readSnapshot

public QueryPlanSnapshot readSnapshot(Path inputFile)
                               throws IOException

Throws:

IOException

findByUnoptimizedFingerprint

public Optional<Path> findByUnoptimizedFingerprint(Path directory,
 String unoptimizedFingerprint)
                                            throws IOException

Throws:

IOException

extractDebugMetrics

public static Map<String,String> extractDebugMetrics(String explanationJson)