Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
fsccashflow Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
renew_assets_summary Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
sfsqlquery Namespace
QueryHandle Class
Row Class
SqlQueueable Class
SqlRowIterator Class
SqlStatement Class
SqlStatement Methods
SqlTester Class
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

SqlStatement Class

Encapsulates the inputs required to execute a Data 360 SQL query against a data space. Build a statement from a raw SQL string or a pre-built ConnectApi.QuerySqlInput object, and then execute synchronously with SqlRowIterator or pass it to a SqlQueueable subclass for asynchronous processing.

Namespace

sfsqlquery

Usage

Use the static create() factories to build a statement, optionally configure the workload name with withWorkloadName(), and then either call execute() to get a synchronous SqlRowIterator or pass the statement to a SqlQueueable subclass for asynchronous execution.

Example

Build and execute a statement synchronously.

1sfsqlquery.SqlRowIterator iterator = sfsqlquery.SqlStatement.create('SELECT Id__c FROM accounts__dlm', 'default')
2    .withWorkloadName('my_workload')
3    .execute();
4
5for (sfsqlquery.Row row : iterator) {
6    System.debug(row.getString('Id__c'));
7}

SqlStatement Methods

The following are methods for SqlStatement.

create(query, dataspace)

Creates a SqlStatement from a pre-built ConnectApi.QuerySqlInput object. Use this method when you need to configure query properties beyond a SQL string, such as parameterized queries, a server-side row limit, or custom query settings.

Keep the class name and .create() on the same line when chaining methods.

Note

Signature

public static sfsqlquery.SqlStatement create(ConnectApi.QuerySqlInput query, String dataspace)

Parameters

query
Type: ConnectApi.QuerySqlInput
Pre-built query input object that can include parameterized queries, a server-side row limit, or custom query settings.
dataspace
Type: String
Name of the Data 360 data space to query against.

Return Value

Type: sfsqlquery.SqlStatement

A new SqlStatement instance configured with the provided query input and data space.

create(sql, dataspace)

Creates a SqlStatement from a raw SQL string and a data space name.

Keep the class name and .create() on the same line when chaining methods.

Note

Signature

public static sfsqlquery.SqlStatement create(String sql, String dataspace)

Parameters

sql
Type: String
SQL query string to execute.
dataspace
Type: String
Name of the Data 360 data space to query against.

Return Value

Type: sfsqlquery.SqlStatement

A new SqlStatement instance configured with the provided SQL and data space.

execute()

Returns a synchronous SqlRowIterator built from this statement. Equivalent to new sfsqlquery.SqlRowIterator(statement). The query isn't submitted until iteration begins.

Signature

public sfsqlquery.SqlRowIterator execute()

Return Value

Type: sfsqlquery.SqlRowIterator

A new SqlRowIterator configured from this statement.

toString()

Returns a string representation of this SqlStatement.

Signature

public String toString()

Return Value

Type: String

A string representation of this SqlStatement.

withWorkloadName(name)

Sets the workload name to send with the query and returns the same SqlStatement instance for method chaining. If not set, the framework uses dcsql_row_iterator_workload for iterators or dcsql_queueable_workload for queueables.

Signature

public sfsqlquery.SqlStatement withWorkloadName(String name)

Parameters

name
Type: String
Custom workload name to associate with the query. Set this value to help Salesforce Customer Support assist you with debugging issues

Return Value

Type: sfsqlquery.SqlStatement

This SqlStatement instance.

Example

Use custom workload names to monitor and throttle different query types:

1// High-priority user-facing query
2sfsqlquery.SqlRowIterator userQuery = sfsqlquery.SqlStatement.create('SELECT * FROM accounts__dlm WHERE Region__c = \'West\'', 'default')
3    .withWorkloadName('salescloud-userdashboard')
4    .execute();
5
6// Background batch processing query
7sfsqlquery.SqlStatement batchStmt = sfsqlquery.SqlStatement.create('SELECT * FROM accounts__dlm', 'default')
8    .withWorkloadName('marketing-nightlybatch');
9System.enqueueJob(new MyBatchJob(batchStmt));