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
Row Constructors
Row Methods
SqlQueueable Class
SqlRowIterator Class
SqlStatement Class
SqlTester Class
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Row Class

Wraps a single Data 360 SQL query result row and provides typed accessor methods for retrieving column values by name or by 0-based index. Row instances are produced by SqlRowIterator and SqlQueueable; you don't construct Row objects directly during normal usage.

Namespace

sfsqlquery

Usage

Every typed accessor is available in two forms: by column name (String) or by 0-based column index (Integer). All typed accessors return null when the underlying value is null. The accessors throw IllegalArgumentException if the column name isn't found or if the column index is out of bounds. Duplicate column names in a result set cause getColumnIndex() to throw IllegalArgumentException.

Example

Access column values by name and by index:

1sfsqlquery.SqlRowIterator iterator = sfsqlquery.SqlStatement.create('SELECT Id__c, Name__c, CreatedDate__c FROM accounts__dlm LIMIT 10', 'default')
2    .execute();
3
4for (sfsqlquery.Row row : iterator) {
5    String id       = row.getString('Id__c');
6    String name     = row.getString(1);           // by index
7    DateTime created = row.getDateTime('CreatedDate__c');
8    System.debug(id + ' ' + name + ' ' + created);
9}

Row Constructors

The following are constructors for Row.

Row(rawRow, metadata)

Creates a Row from a raw API row and column metadata. In normal usage you don't construct Row objects directly — they're produced by SqlRowIterator and SqlQueueable.

Signature

public Row(ConnectApi.QuerySqlRow rawRow, List<ConnectApi.QuerySqlMetadataItem> metadata)

Parameters

rawRow
Type: ConnectApi.QuerySqlRow
Raw API row from a ConnectApi.QuerySqlPageOutput result.
metadata
Type: List<ConnectApi.QuerySqlMetadataItem>
Column metadata for the result set, used to map column names to indexes.

Row Methods

The following are methods for Row.

getBoolean(columnIndex)

Returns the value of the column at the specified 0-based index as a Boolean. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.

Signature

public Boolean getBoolean(Integer columnIndex)

Parameters

columnIndex
Type: Integer
0-based column index.

Return Value

Type: Boolean

The column value as a Boolean, or null.

getBoolean(columnName)

Returns the value of the specified column as a Boolean. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.

Signature

public Boolean getBoolean(String columnName)

Parameters

columnName
Type: String
Column name.

Return Value

Type: Boolean

The column value as a Boolean, or null.

getColumnIndex(columnName)

Returns the 0-based index of the specified column name in the result set. Use this to look up an index once and then access multiple rows efficiently using index-based getters. Throws IllegalArgumentException if the column names are repeated in the table.

Signature

public Integer getColumnIndex(String columnName)

Parameters

columnName
Type: String
Name of the column to look up.

Return Value

Type: Integer

The 0-based column index, or -1 if the column name is not found.

getDate(columnIndex)

Returns the value of the column at the specified 0-based index as a Date. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.

Signature

public Date getDate(Integer columnIndex)

Parameters

columnIndex
Type: Integer
0-based column index.

Return Value

Type: Date

The column value as a Date, or null.

getDate(columnName)

Returns the value of the specified column as a Date. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.

Signature

public Date getDate(String columnName)

Parameters

columnName
Type: String
Column name.

Return Value

Type: Date

The column value as a Date, or null.

getDateTime(columnIndex)

Returns the value of the column at the specified 0-based index as a Datetime. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.

Signature

public Datetime getDateTime(Integer columnIndex)

Parameters

columnIndex
Type: Integer
0-based column index.

Return Value

Type: Datetime

The column value as a Datetime, or null.

getDateTime(columnName)

Returns the value of the specified column as a Datetime. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.

Signature

public Datetime getDateTime(String columnName)

Parameters

columnName
Type: String
Column name.

Return Value

Type: Datetime

The column value as a Datetime, or null.

getDecimal(columnIndex)

Returns the value of the column at the specified 0-based index as a Decimal. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.

Signature

public Decimal getDecimal(Integer columnIndex)

Parameters

columnIndex
Type: Integer
0-based column index.

Return Value

Type: Decimal

The column value as a Decimal, or null.

getDecimal(columnName)

Returns the value of the specified column as a Decimal. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.

Signature

public Decimal getDecimal(String columnName)

Parameters

columnName
Type: String
Column name.

Return Value

Type: Decimal

The column value as a Decimal, or null.

getDouble(columnIndex)

Returns the value of the column at the specified 0-based index as a Double. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.

Signature

public Double getDouble(Integer columnIndex)

Parameters

columnIndex
Type: Integer
0-based column index.

Return Value

Type: Double

The column value as a Double, or null.

getDouble(columnName)

Returns the value of the specified column as a Double. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.

Signature

public Double getDouble(String columnName)

Parameters

columnName
Type: String
Column name.

Return Value

Type: Double

The column value as a Double, or null.

getInteger(columnIndex)

Returns the value of the column at the specified 0-based index as an Integer. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.

Signature

public Integer getInteger(Integer columnIndex)

Parameters

columnIndex
Type: Integer
0-based column index.

Return Value

Type: Integer

The column value as an Integer, or null.

getInteger(columnName)

Returns the value of the specified column as an Integer. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.

Signature

public Integer getInteger(String columnName)

Parameters

columnName
Type: String
Column name.

Return Value

Type: Integer

The column value as an Integer, or null.

getList(columnIndex)

Returns the value of the column at the specified 0-based index as a List<Object>. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.

Signature

public List<Object> getList(Integer columnIndex)

Parameters

columnIndex
Type: Integer
0-based column index.

Return Value

Type: List<Object>

The column value as a List<Object>, or null.

getList(columnName)

Returns the value of the specified column as a List<Object>. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.

Signature

public List<Object> getList(String columnName)

Parameters

columnName
Type: String
Column name.

Return Value

Type: List<Object>

The column value as a List<Object>, or null.

getLong(columnIndex)

Returns the value of the column at the specified 0-based index as a Long. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.

Signature

public Long getLong(Integer columnIndex)

Parameters

columnIndex
Type: Integer
0-based column index.

Return Value

Type: Long

The column value as a Long, or null.

getLong(columnName)

Returns the value of the specified column as a Long. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.

Signature

public Long getLong(String columnName)

Parameters

columnName
Type: String
Column name.

Return Value

Type: Long

The column value as a Long, or null.

getObject(columnIndex)

Returns the value of the column at the specified 0-based index as an Object. Use this when the column type is unknown or when you need the raw untyped value. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.

Signature

public Object getObject(Integer columnIndex)

Parameters

columnIndex
Type: Integer
0-based column index.

Return Value

Type: Object

The column value as an Object, or null.

getObject(columnName)

Returns the value of the specified column as an Object. Use this when the column type is unknown or when you need the raw untyped value. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.

Signature

public Object getObject(String columnName)

Parameters

columnName
Type: String
Column name.

Return Value

Type: Object

The column value as an Object, or null.

getRawRow()

Returns the underlying ConnectApi.QuerySqlRow object. Use this for direct access to the raw API response when the typed accessor methods don't meet your needs.

Signature

public ConnectApi.QuerySqlRow getRawRow()

Return Value

Type: ConnectApi.QuerySqlRow

The underlying ConnectApi.QuerySqlRow for this row.

getString(columnIndex)

Returns the value of the column at the specified 0-based index as a String. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.

Signature

public String getString(Integer columnIndex)

Parameters

columnIndex
Type: Integer
0-based column index.

Return Value

Type: String

The column value as a String, or null.

getString(columnName)

Returns the value of the specified column as a String. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.

Signature

public String getString(String columnName)

Parameters

columnName
Type: String
Column name.

Return Value

Type: String

The column value as a String, or null.

getTime(columnIndex)

Returns the value of the column at the specified 0-based index as a Time. Returns null if the column value is null. Throws IllegalArgumentException if the column index is out of bounds.

Signature

public Time getTime(Integer columnIndex)

Parameters

columnIndex
Type: Integer
0-based column index.

Return Value

Type: Time

The column value as a Time, or null.

getTime(columnName)

Returns the value of the specified column as a Time. Returns null if the column value is null. Throws IllegalArgumentException if the column name is not found.

Signature

public Time getTime(String columnName)

Parameters

columnName
Type: String
Column name.

Return Value

Type: Time

The column value as a Time, or null.

toString()

Returns a string representation of this Row.

Signature

public String toString()

Return Value

Type: String

A string representation of this Row.