cloudship.data — cloudship 0.1.1

Namespace with the data api

->id clj

(->id id-or-map)

count-records clj

(count-records cloudship object)

(count-records cloudship object options)

Returns the number of records for a given Object and options. Options are the same as q.

delete clj

(delete cloudship records-or-ids)

(delete cloudship records-or-ids options)

Deletes the given maps (with ids) or ids. If option :dont-ask is not set, asks before deleting records. Other possible option are: {:partition-size size, :bulk true, :serial true}

describe clj

(describe cloudship)

Returns the global describe data for the given cloudship.

describe-id clj

(describe-id cloudship id)

Returns the Objectnames for the given cloudship and salesforce id(-prefix). Only checks the first 3 letters of a given id as they determine the object type. As there are edge cases where more than one object with a given prefix, a list is returned. If now Object is found, returns nil and logs a warning.

describe-object clj

(describe-object cloudship object-name)

Returns the describe data for the given cloudship and a single given object.

describe-objects clj

(describe-objects cloudship & object-names)

Returns the describe data for the given cloudship and objects (as list or as varargs).

evict clj

(evict cloudship)

Removes the connection for this keyword/prop-map from the cache

info clj

(info cloudship)

Returns information for this client. Usally contains username, session, url and the underlying client.

insert clj

(insert cloudship records)

(insert cloudship records options)

Insert for given maps. All records must have a valid :type. Possible options are: {:partition-size size, :bulk true, :serial true}.

q clj

(q cloudship object field-or-fields)

(q cloudship object field-or-fields {:keys [in all] :as options})

Structured version of the query function. Is not limited to 2000 records (uses QueryLocator if needed). Also understands '*' or ':all' (all fields), ':required' (required fields) as field-or-fields. Given a function for field-or-fields, it will run it as predicate on the field metadata. This especially works for keywords like ':updateable' or ':createable'. Always queries Id. Options are {:where WhereString, :in [infield idset] :all true (query-all) :limit limitnumber :bulk true} If the idset of :in is too big and results in a too long query, it will automaticly split the query and concat the results again.

query clj

(query cloudship query-string)

(query cloudship query-string options)

Returns the result of this SOQL query-string for the given cloudship. Have a look at 'q' for a more structured way to query.

remove-from-bin clj

(remove-from-bin cloudship records-or-ids)

(remove-from-bin cloudship records-or-ids options)

Removes the given maps (with ids) or ids from the bin

undelete clj

(undelete cloudship records-or-ids)

(undelete cloudship records-or-ids options)

Undeletes the given maps (with ids) or ids

update clj

(update cloudship records)

(update cloudship records options)

Update for given maps. All records must have :Id and a valid :type. Possible options are: {:partition-size size, :bulk true, :serial true}.

upsert clj

(upsert cloudship records options)

Upsert for given maps. All records must have :Id and a valid :type. The :upsert-key option needs to be set, therefor upsert has no arity without options. Other possible options are: {:partition-size size, :bulk true, :serial true}.

user-info clj

(user-info cloudship)

Returns the userinfo for a cloudship