JDBC Driver for Salesforce Chatter

Build 21.0.7930

Groups

Retrieve Group details.

Table Specific Information

Select

To query this table, you must specify CommunityId, UserId, TopicId, Id (the primary key), or a combination of two Ids. The = and AND operators are allowed. The driver will use the Salesforce Chatter API to process filters based on these columns.

Filters on other columns are executed client side within the driver. For example, the following query is executed to the Salesforce Chatter APIs:

SELECT Name FROM Groups WHERE TopicId = 'abc123'

You can also use the Salesforce Chatter APIs to filter through Groups: Set the SearchTerms parameter to match group names.

SELECT * FROM Groups WHERE UserId = 'abc123' AND SearchTerms = 'test*'

Note: The use of wildcards is permitted when filtering Groups:

  • * matches zero or more characters at the middle or end of your search term.
  • ? matches only one character in the middle or end of your search term.

You can turn off client-side execution by setting SupportEnhancedSQL to false in which case any search criteria that refer to any other columns will cause an error.

Columns

Name Type Description
Id [KEY] String The unique identifier of the group.
Name String The name of the group.
SearchTerms String Query to search the files database.
Title String Information title for the current group.
Text String Information text for the current group.
Type String The group type description.
Url String The group url.
CanHaveChatterGuests Boolean Whether the group can have Chatter guests.
Description String The group description.
FileCount Integer Number of files belonging to the current group.
IsArchived Boolean Whether the group is archived.
IsAutoArchiveDisabled Boolean Whether the group has automatic archive disabled.
IsBroadcast Boolean Whether the group has broadcast.
LastFeedTime Datetime The date and time when the feed was last updated.
MemberCount Integer Number of user members belonging to the current group.
MyRole String Current user's role in the specified group.
MySubscriptionId String The group's subscription id.
MySubscriptionUrl String The group's subscription url.
OwnerId String Display name of the group owner.
OwnerDisplayName String Id of the group owner.
OwnerPhoto String Photo URL of the group owner.
OwnerTitle String Title of the group owner.
PhotoUrl String Photo URL of the group.
Visibility String Visibility kind for the current group.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name Type Description
IsMe Boolean Instead of specifying your exact Id, set this to true to retrieve your account information
ArchiveStatus String Returns the list of groups filtered by the archive status you specify: All, Archived, or NotArchived. Default is NotArchived.
TopicId String Id of the topic associated with the current group.
CommunityId String Id of the community associated with the current group.
UserId String Id of the user associated with the current group.

Copyright (c) 2021 CData Software, Inc. - All rights reserved.
Build 21.0.7930