Field Metadata
Pull all the fields in your Salesforce instance, per Object, or optionally just a single specified Object's fields.
Note, results will not be affected by the Field Level Security (FLS) of the user connecting to Salesforce, however some fields cannot be returned with ss_MetaFieldX, for example the compound address fields from an Address field (eg BillingStreet from BillingAddress).
Results are loaded to table ss_SysFieldX
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_MetaFieldX 'UAT', 'All'
SQL-SALES ss_SysFieldX run date: 2026-04-09 ----------------------
20:30:09: v26.2.0.1 Copyright c 2026 SQL-Sales Ltd
20:30:09: Using Env|Schema: uat|dbo
20:30:09: Starting ss_SysFieldX retrieval for: All Objects
20:30:12: Connection with Username/Password/ST (BULK & REST API)
20:30:12: Drop existing ss_SysFieldX if exists and recreate
20:32:34: Load to dbo.ss_SysFieldX
-----------------------------------------------------------------
Example of Use - Single
exec ss_MetaFieldX 'UAT', 'Account'
SQL-SALES ss_SysFieldX run date: 2026-04-09 ----------------------
20:34:21: v26.2.0.1 Copyright c 2026 SQL-Sales Ltd
20:34:21: Using Env|Schema: uat|dbo
20:34:21: Starting ss_SysFieldX retrieval for: Account
20:34:24: Connection with Username/Password/ST (BULK & REST API)
20:34:24: Drop existing ss_SysFieldX if exists and recreate
20:34:26: Load to dbo.ss_SysFieldX
-----------------------------------------------------------------
ss_SysFieldX table
ObjectName (Object api Name)
ObjectLabel (Object Label)
ObjectReplicateable (boolean)
ObjectQueryable (boolean)
FieldName (Field api Name)
FieldLabel (Field Label)
Description (Field description)
DataType (Field data type)
Length
Precision
Scale
Required (boolean)
Unique (boolean)
ExternalId (boolean)
Deprecated (boolean)
DefaultValue
Formula
InlineHelpText
ReferenceTo (Related Object(s))
RelationshipName
RelationshipLabel
DisplayFormat
MaskType
MaskChar
EncryptionScheme
SecurityClassification
TrackFeedHistory (boolean)
TrackHistory (boolean)
Custom (boolean)