README
¶
SOQL (Salesforce Object Query Language)
Utilitzes method chaining and the builder design pattern to elegantly build SOQL queries.
In this context SOQL is a read-only API for querying data from the salesforce REST API. It does not support parameterized inputs. There are SQL Injection Vulnerabilities if you allow unsanitized input from the web.
One method of SQL Injection for example would be to unescape the single quotes which encapsulate strings in SOQL and inserting additional fields within a query. This is difficult but especially because this code is open sourced it is still a threat.
Sanitize your inputs. Even
builder := soql.
Select("Id", "Name").
From("Lead").
Where(soql.And{
soql.Eq{"FirstName": "Benjamin"},
// salesforce datetime's use a custom format which types.Datetime accomodates
soql.Gt{"CreatedDate": types.NewDatetime(time.Now().Add(time.Hour).String())},
}).
Limit(1)
SOQL is intended to be used directly with the requests package.
type entityQuery struct {
types.QueryResponse
Records []*entitydefinitions.EntityDefinition `json:"records"`
}
var response entityQuery
_, err := requests.
Sender(salesforce.DefaultClient).
URL("tooling/query").
SQLizer(soql.
Select("QualifiedApiName").
From("EntityDefinition").
Limit(10)).
JSON(&response)
It has no issues querying parent records or child records (via subqueries). However you should use generated types with a recursion level of 1 so that they may be unmarshalled automatically.
go-salesforce-sdk generate Lead ./ leads 1
type leadQuery struct {
types.QueryResponse
Records []*leads.Lead `json:"records"`
}
var response2 leadQuery
subquery := soql.Select("Id", "Body").From("Attachments")
_, err = requests.
Sender(salesforce.DefaultClient).
URL("query").
SQLizer(
soql.
Select("Id", "Name").
Column(soql.SubQuery(subquery)).
From("Lead").
Limit(10),
).
JSON(&response2)
Documentation
¶
Index ¶
- Variables
- type And
- type Builder
- func (b Builder) Column(column interface{}) Builder
- func (b Builder) Columns(columns ...string) Builder
- func (b Builder) From(from string) Builder
- func (b Builder) FromSelect(from Builder, alias string) Builder
- func (b Builder) GroupBy(groupBys ...string) Builder
- func (b Builder) Having(pred interface{}) Builder
- func (b Builder) Limit(limit int) Builder
- func (b Builder) MustSQL() string
- func (b Builder) Offset(offset int) Builder
- func (b Builder) Options(options ...string) Builder
- func (b Builder) OrderBy(orderBys ...string) Builder
- func (b Builder) OrderByClause(pred interface{}) Builder
- func (b Builder) Prefix(sql string) Builder
- func (b Builder) RemoveLimit() Builder
- func (b Builder) RemoveOffset() Builder
- func (b Builder) SetColumns(columns ...string) Builder
- func (b Builder) Suffix(sql string) Builder
- func (b Builder) ToSQL() (string, error)
- func (b Builder) Where(predicate interface{}) Builder
- type Eq
- type Fragment
- type Gt
- type GtOrEq
- type Like
- type Lt
- type LtOrEq
- type NotEq
- type NotLike
- type Or
- type SQLizer
Constants ¶
This section is empty.
Variables ¶
var Empty = sb
Empty is a empty builder useful for
Functions ¶
This section is empty.
Types ¶
type Builder ¶
Builder is used to compose highly dynamic and reusable SOQL queries
func String ¶
String returns a SelectBuilder composed as a singular string. This builder should not be extended as the query is stored and prepended as a prefix to form the entire query. Its used to satisy the requests.SQLizer signature when a string is the only input.
func (Builder) FromSelect ¶
FromSelect sets a subquery into the FROM clause of the query.
func (Builder) Options ¶
Options adds an additional clause between SELECT and COLUMNS, not sure if this has any application within SOQL but I'll keep it in case it proves useful one day (I don't think its unreasonable to expect Salesforce to port more features from Postgres/MariaDB/etc over time)
func (Builder) OrderByClause ¶
OrderByClause appends an OrderBy clause to selectData
func (Builder) RemoveLimit ¶
RemoveLimit removes a limit from a query
func (Builder) RemoveOffset ¶
RemoveOffset removes an offset from the queery
func (Builder) SetColumns ¶
SetColumns is like Columns but it replaces existing columns rather then extending them
func (Builder) Where ¶
Where builds a where clause using nested SQLizers. Each SQLizer is responsible for serializing itself and any nested SQLizer, so all the SelectBuilder needs to do is maintain and apply a list of top-level SQLizers. See expressions.go for how the SQLizers work in practice.
The following types are accepted as a predicate (as seen in newWhereSQLizer()):
switch predicate.(type) { case nil:
// noop return "", nil
case SQLizer:
return pred.ToSQL()
case map[string]interface{}:
return Eq(pred).ToSQL()
case string:
return pred, nil
type Eq ¶
type Eq map[string]interface{}
Eq produces a complex clause for use by Where/Having methods. It may contain nested values and lists which are converted into IN queries.
Source Files