Object Metadata
Pull all the objects in your Salesforce instance, or optionally just a single specified one.
Results are loaded to table ss_SysObject
Parameters
Parameter | Purpose |
@ObjectName | Salesforce Object Name (for example Account). alternatively pass "All" to retrieve all Objects. |
@Env | SQL Sales Environment Name, see Setup |
@Special1 | Future use, not currently used |
@Special2 | Future use, not currently used |
Example of Use – All
exec ss_MetaObject 'DEMO', 'All'
SQL-SALES ss_SysObject run date: 2023-11-09 ----------------------
23:04:16: Using Env|Schema: DEMO|dbo
23:04:16: Starting ss_SysObject retrieval for: All Objects
23:04:19: Connection method BULK & SOAP API
23:04:19: Drop existing ss_SysObject if exists and recreate
23:04:21: Load to dbo.ss_SysObject
-----------------------------------------------------------------
Example of Use – Single
exec ss_MetaObject 'DEMO', 'Account'
SQL-SALES ss_SysObject run date: 2023-11-09 ----------------------
23:06:59: Using Env|Schema: DEMO|dbo
23:06:59: Starting ss_SysObject retrieval for: Account
23:07:02: Connection method BULK & SOAP API
23:07:02: Drop existing ss_SysObject if exists and recreate
23:07:04: Load to dbo.ss_SysObject
-----------------------------------------------------------------
ss_SysObject table
Column Name | Purpose |
ObjectName | API name of the Salesforce object (e.g. Account, Custom_Object__c). |
ObjectLabel | User-friendly label of the object as shown in the UI. |
KeyPrefix | Unique 3-character prefix used in Salesforce record IDs to identify the object type (e.g. 001 = Account). |
Replicateable | If the object supports replication via APIs (e.g. Bulk API, CDC scenarios). |
Queryable | If the object can be queried using SOQL. |
Createable | If new records can be created for this object via API. |
Updateable | If existing records can be updated via API. |
Deletable | If records can be deleted from this object. |
Searchable | If the object is searchable (e.g. via global search or SOSL). |
Retrieveable | If records can be retrieved via API calls. |
Layoutable | If the object supports page layouts. |
Triggerable | If Apex triggers can be defined on the object. |
Mergeable | If records of this object can be merged (e.g. Accounts, Contacts, Leads). |
Custom | If the object is custom (1) or standard (0). |