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
commonserviceexcellence Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
AsyncDeleteCallback Class
AsyncSaveCallback Class
AuthenticationCapability Enum
AuthenticationProtocol Enum
Capability Enum
Column Class
ColumnSelection Class
Connection Class
ConnectionParams Class
DataSourceUtil Class
DataType Enum
DeleteContext Class
DeleteResult Class
Filter Class
FilterType Enum
IdentityType Enum
Order Class
OrderDirection Enum
Provider Class
QueryAggregation Enum
QueryContext Class
QueryUtils Class
ReadContext Class
SearchContext Class
SearchUtils Class
Table Class
Table Properties
Table Methods
TableResult Class
TableSelection Class
UpsertContext Class
UpsertResult Class
DataSource Exceptions
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
disputemanagement Namespace
fsccashflow Namespace
fsccomplaintmanagement Namespace
fschousehold Namespace
fscserviceprocesses Namespace
fscwmgen Namespace
industriespersonalizedfinance 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
sfdw Namespace
sfsqlquery Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Table Class

Describes a table on an external system that the Salesforce Connect custom adapter connects to. This class extends the DataSourceUtil class and inherits its methods.

Namespace

DataSource

Usage

A list of table metadata is provided by the DataSource.Connection class when the sync() method is invoked. Each table can become an external object in Salesforce.

The metadata is stored in Salesforce. Updating the Apex code to return new or updated values for the table metadata doesn’t automatically update the stored metadata in Salesforce.

Table Properties

The following are properties for Table.

columns

List of table columns.

Signature

public List<DataSource.Column> columns {get; set;}

Property Value

Type: List<DataSource.Column>

description

Description of what the table represents.

Signature

public String description {get; set;}

Property Value

Type: String

labelPlural

Plural form of the user-friendly name for the table. The labelPlural becomes the object’s plural label in the Salesforce user interface.

Signature

public String labelPlural {get; set;}

1DataSource.Table, labelPlural

Property Value

Type: String

labelSingular

Singular form of the user-friendly name for the table. The labelSingular becomes the object label in the Salesforce user interface. We recommend that you make object labels unique across all standard, custom, and external objects in the org.

Signature

public String labelSingular {get; set;}

Property Value

Type: String

name

Name of the table on the external system.

Signature

public String name {get; set;}

Property Value

Type: String

nameColumn

Name of the table column that becomes the name field of the external object when the administrator syncs the table.

Signature

public String nameColumn {get; set;}

Property Value

Type: String

Table Methods

The following are methods for Table.

get(name, labelSingular, labelPlural, description, nameColumn, columns)

Returns the table metadata with the specified parameter values.

Signature

public static DataSource.Table get(String name, String labelSingular, String labelPlural, String description, String nameColumn, List<DataSource.Column> columns)

Parameters

  • name:

    Type: String

    Name of the external table.

  • labelSingular:

    Type: String

    Singular form of the user-friendly name for the table. The labelSingular becomes the object label in the Salesforce user interface.

  • labelPlural:

    Type: String

    Plural form of the user-friendly name for the table. The labelPlural becomes the object’s plural label in the Salesforce user interface.

  • description:

    Type: String

    Description of the external table.

  • nameColumn:

    Type: String

    Name of the table column that becomes the name field of the external object when the administrator syncs the table.

  • columns:

    Type: List<DataSource.Column>

    List of table columns.

Return Value

Type: DataSource.Table

get(name, nameColumn, columns)

Returns the table metadata with the specified parameter values, using the name for the labels and description.

Signature

public static DataSource.Table get(String name, String nameColumn, List<DataSource.Column> columns)

1DataSource.Table, get, [String, String, List<DataSource.Column>], DataSource.Table

Parameters

  • name:

    Type: String

    Name of the external table.

  • nameColumn:

    Type: String

    Name of the table column that becomes the name field of the external object when the administrator syncs the table.

  • columns:

    Type: List<DataSource.Column>

    List of table columns.

Return Value

Type: DataSource.Table

The returned table metadata has these property values.
Property Value
name name
labelSingular name
labelPlural name
description name
nameColumn nameColumn
columns columns