Skip to main content
ss_MetaField

Field Metadata

Updated over 3 months ago

Field Metadata

Pull all the fields in your Salesforce instance, per Object, or optionally just a single specified Object's fields.

Results are loaded to table ss_SysField

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_MetaField 'DEMO', 'All'

SQL-SALES ss_SysField run date: 2023-11-09 ----------------------

23:15:07: Using Env|Schema: DEMO|dbo

23:15:07: Starting ss_SysField retrieval for: All Objects

23:15:09: Connection method BULK & SOAP API

23:15:09: Drop existing ss_SysField if exists and recreate

23:16:57: Load to dbo.ss_SysField

-----------------------------------------------------------------

Example of Use - Single

exec ss_MetaField 'DEMO', 'Account'

SQL-SALES ss_SysField run date: 2023-11-09 ----------------------

23:22:56: Using Env|Schema: DEMO|dbo

23:22:56: Starting ss_SysField retrieval for: Account

23:22:58: Connection method BULK & SOAP API

23:22:58: Drop existing ss_SysField if exists and recreate

23:23:00: Load to dbo.ss_SysField

-----------------------------------------------------------------

ss_SysField table

  • ObjectName (Object api Name)

  • ObjectLabel (Object Label)

  • ObjectReplicateable (boolean)

  • ObjectQueryable (boolean)

  • FieldName (Field api Name)

  • FieldLabel (Field Label)

  • DataType (Field data type)

  • Length (Field data length)

  • ByteLength (Field byte size)

  • Updateable (boolean)

  • Createable (boolean)

  • Unique (boolean)

  • Nillable (boolean)

  • Custom (boolean)

  • DependentPicklist (boolean)

  • DeprecatedAndHidden (boolean)

  • Encrypted (boolean)

  • ExternalId (boolean)

  • NameField (boolean)

  • Permissionable (boolean)

  • ReferenceTo (Related Object(s))

Did this answer your question?