Skip to main content

SLAM_describe_objects

Overview​

Retrieves Salesforce object definitions to table DESCRIBE_OBJECTS.

warning

The list of objects returned is subject to Salesforce permissions. Only the objects the user has read access or greater to in Salesforce are returned.

Parameters​

NameTypeDefaultDescription
@tableVARCHAR(256)'DESCRIBE_OBJECTS'Destination table name
@exists_actionVARCHAR(20)NULLControls the behavior when the destination table already exists. If NULL, uses the value from SLAM_Settings.default_exists_action (defaulted to 'drop' during initial setup).

Valid options:

  • 'drop' - Drop the existing object and create a new one (default)
  • 'rename' - Rename the existing object by appending a timestamp suffix (format: _YYYYMMDDTHHMMSS_MMM)
  • 'fail' - Throws a SQL exception if the destination object already exists

Usage Examples​

EXEC dbo.SLAM_describe_objects;

SELECT * FROM DESCRIBE_OBJECTS;

With a custom destination table:

EXEC dbo.SLAM_describe_objects
    @table = 'MY_OBJECTS';

SELECT * FROM MY_OBJECTS;

With explicit exists action:

EXEC dbo.SLAM_describe_objects
    @exists_action = 'rename';