Field Metadata
Pulls extended Salesforce field metadata, including descriptions, formulas, relationships, security settings, and compliance attributes, providing a comprehensive view of field design, behaviour, and governance.
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
Column Name | Purpose |
ObjectName | API name of the Salesforce object the field belongs to |
ObjectLabel | User-friendly label of the object |
ObjectReplicateable | If the object supports replication via API |
ObjectQueryable | If the object can be queried via SOQL |
FieldName | API name of the field |
FieldLabel | User-friendly label of the field |
Description | Description of the field as defined in Salesforce metadata |
DataType | Salesforce data type of the field |
Length | Maximum length for text-based fields |
Precision | Total number of digits for numeric fields |
Scale | Number of decimal places for numeric fields |
Required | If the field is mandatory (cannot be null) |
Unique | If the field enforces unique values |
ExternalId | If the field is marked as an External ID |
Deprecated | Indicates if the field is deprecated or hidden |
DefaultValue | Default value assigned to the field (if any) |
Formula | Formula definition for calculated fields |
InlineHelpText | Help text displayed to users in the UI |
ReferenceTo | Object(s) referenced by lookup or master-detail fields |
RelationshipName | API name of the relationship for reference fields |
RelationshipLabel | User-friendly label of the relationship |
DisplayFormat | Display format for special fields (e.g. auto-number) |
MaskType | Type of masking applied (for encrypted/masked fields) |
MaskChar | Character used for masking field values |
EncryptionScheme | Encryption type used for the field (if applicable) |
SecurityClassification | Data classification level (e.g. Public, Confidential, Restricted) |
TrackFeedHistory | If field changes are tracked in feed (Chatter) |
TrackHistory | If field history tracking is enabled |
Custom | If the field is custom (1) or standard (0) |