Streaming API Developer Guide

Getting Started with Streaming API
Code Examples
Client Connection Considerations
PushTopic Events (Legacy)
Working with PushTopics
PushTopic Queries
Security and the PushTopic Query
Supported PushTopic Queries
Compound Fields in PushTopic Queries
Unsupported PushTopic Queries
Event Notification Rules
Replay PushTopic Streaming Events
Filtered Subscriptions
Bulk Subscriptions
Deactivating a Push Topic
PushTopic Considerations
PushTopic Streaming Allocations
Reference: PushTopic
Generic Events (Legacy)
Monitoring Event Usage
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Unsupported PushTopic Queries

These SOQL statements aren’t supported in PushTopic queries.

  • Queries without an Id in the selected fields list
  • Semi-joins and anti-joins
    • Example query: SELECT Id, Name FROM Account WHERE Id IN (SELECT AccountId FROM Contact WHERE Title = 'CEO')
    • Error message: INVALID_FIELD, semi/anti join sub-selects are not supported
  • Aggregate queries (queries that use AVG, MAX, MIN, and SUM)
    • Example query: SELECT Id, AVG(AnnualRevenue) FROM Account
    • Error message: INVALID_FIELD, Aggregate queries are not supported
  • COUNT
    • Example query: SELECT Id, Industry, Count(Name) FROM Account
    • Error message: INVALID_FIELD, Aggregate queries are not supported
  • LIMIT
    • Example query: SELECT Id, Name FROM Contact LIMIT 10
    • Error message: INVALID_FIELD, 'LIMIT' is not allowed
  • Relationships aren’t supported, but you can reference an ID:
    • Example query: SELECT Id, Contact.Account.Name FROM Contact
    • Error message: INVALID_FIELD, relationships are not supported
  • Searching for values in Text Area fields.
  • ORDER BY
    • Example query: SELECT Id, Name FROM Account ORDER BY Name
    • Error message: INVALID_FIELD, 'ORDER BY' clause is not allowed
  • GROUP BY
    • Example query: SELECT Id, AccountId FROM Contact GROUP BY AccountId
    • Error message: INVALID_FIELD, 'Aggregate queries are not supported'
  • Formula fields in WHERE clauses (But formula fields are supported in SELECT clauses.)
  • NOT
    • Example query: SELECT Id FROM Account WHERE NOT Name = 'Salesforce.com'
    • Error message: INVALID_FIELD, 'NOT' is not supported

    To make this a valid query, change it to SELECT Id FROM Account WHERE Name != 'Salesforce.com'.

    The NOT IN phrase is supported in PushTopic queries.

    Note

  • OFFSET
    • Example query: SELECT Id, Name FROM Account WHERE City = 'New York' OFFSET 10
    • Error message: INVALID_FIELD, 'OFFSET' clause is not allowed
  • TYPEOF
    • Example query: SELECT TYPEOF Owner WHEN User THEN LastName ELSE Name END FROM Case
    • Error message: INVALID_FIELD, 'TYPEOF' clause is not allowed
  • Roll-up summary fields. If a PushTopic query contains a roll-up summary field for an object, notifications aren’t be sent for changes (create, update, delete, and undelete) in that field.