SFSDKSoqlBuilder Class Reference

Inherits from	NSObject
Declared in	SFSDKSoqlBuilder.h

Query Builder

`+ withFields:`

A builder to help create a SOQL statement.

+ (SFSDKSoqlBuilder *)withFields:(NSString *)fields

Parameters

`fields`	a list of one or more fields, separated by commas, that are to be retrieved from the specified object

Return Value

the builder

Declared In

SFSDKSoqlBuilder.h

`+ withFieldsArray:`

A builder to help create a SOQL statement.

+ (SFSDKSoqlBuilder *)withFieldsArray:(NSArray *)fields

Parameters

`fields`	an array of one or more fields, that are to be retrieved from the specified object

Return Value

the builder

Declared In

SFSDKSoqlBuilder.h

`– from:`

A builder to help create a SOQL statement.

- (SFSDKSoqlBuilder *)from:(NSString *)from

Parameters

`from`	the object to be queried

Return Value

the builder

Declared In

SFSDKSoqlBuilder.h

`– whereClause:`

A builder to help create a SOQL statement.

- (SFSDKSoqlBuilder *)whereClause:(NSString *)whereClause

Parameters

`whereClause`	a conditional statement

Return Value

the builder

Declared In

SFSDKSoqlBuilder.h

`– with:`

A builder to help create a SOQL statement.

- (SFSDKSoqlBuilder *)with:(NSString *)with

Parameters

`with`	used to filter records based on field values.

Return Value

the builder

Declared In

SFSDKSoqlBuilder.h

`– groupBy:`

A builder to help create a SOQL statement.

- (SFSDKSoqlBuilder *)groupBy:(NSString *)groupBy

Parameters

`groupBy`	a list of one or more fields, separated by commas, the resutls are to be grouped by

Return Value

the builder

Declared In

SFSDKSoqlBuilder.h

`– having:`

A builder to help create a SOQL statement.

- (SFSDKSoqlBuilder *)having:(NSString *)having

Parameters

`having`	specifies one or more conditional expressions using aggregate functions to filter the query results

Return Value

the builder

Declared In

SFSDKSoqlBuilder.h

`– orderBy:`

A builder to help create a SOQL statement.

- (SFSDKSoqlBuilder *)orderBy:(NSString *)orderBy

Parameters

`orderBy`	controls the order of the query results

Return Value

the builder

Declared In

SFSDKSoqlBuilder.h

`– limit:`

A builder to help create a SOQL statement.

- (SFSDKSoqlBuilder *)limit:(NSInteger)limit

Parameters

`limit`	specifies the maximum number of rows to return

Return Value

the builder

Declared In

SFSDKSoqlBuilder.h

`– offset:`

A builder to help create a SOQL statement.

- (SFSDKSoqlBuilder *)offset:(NSInteger)offset

Parameters

`offset`	specifies the starting row offset into the result set returned by the query

Return Value

the builder

Declared In

SFSDKSoqlBuilder.h

Query String Generation

`– encodeAndBuild`

Builds an encoded query from the builder.

- (NSString *)encodeAndBuild

Return Value

the built query

Declared In

SFSDKSoqlBuilder.h

`– encodeAndBuildWithPath:`

Builds an enoded query from the builder.

- (NSString *)encodeAndBuildWithPath:(NSString *)path

Parameters

`path`	the path to build the query for

Return Value

the built query

Declared In

SFSDKSoqlBuilder.h

`– buildWithPath:`

Builds a raw (unencoded) query from the builder.

- (NSString *)buildWithPath:(NSString *)path

Parameters

`path`	the path to build the query for

Return Value

the built query

Declared In

SFSDKSoqlBuilder.h

`– build`

Builds a raw (unencoded) query from the builder.

- (nullable NSString *)build

Return Value

the built query

Declared In

SFSDKSoqlBuilder.h