DataSync API for PHP SDK

DataSync is PubNub's data layer for storing application state (users, channels, memberships, and any custom object type) and keeping every connected client current through real-time events. Use it to model the objects your application works with and to react the moment they change.

DataSync is the successor to App Context.

DataSync entities and SDK entities are different things

This page is about DataSync entities, the records the service stores and treats as the source of truth for your application state. They are created and read through the $pubnub->dataSync()->* methods documented here.

The PHP SDK has no client-side SDK entity concept. A channel ID is just the string you pass to channels() when you subscribe, it carries no stored state of its own. To observe a DataSync object in real time, subscribe to its channel and attach a DataSync listener to the PubNub client, as described in Real-time updates.

The classes that your objects conform to (their types and schemas) are defined through the Admin API or the Admin Portal, not through this SDK:

• Entity classes, which back users, channels, and custom entities: list, read, create, replace, and delete. Partial updates aren't implemented; replace the complete class version instead.
• Relationship classes, which back memberships and custom relationships: list, read, create, replace, and delete.

User and Channel entity classes and the Membership relationship class are predefined on every keyset, so you only need to define classes for your own custom entities and relationships.

A class definition is what decides, for every object of that class, which payload fields are filterable and sortable, which projection each field belongs to, and how long the object lives before it expires. Refer to managing classes for more information.

Every method returns a typed result from sync(), or a PNEnvelope from envelope() that carries the result and the status side by side. The single-object methods return a result whose getData() holds the record, with getId() and getETag() as shortcuts. The list methods return a result whose getData() holds an array of records, with count() and getPage() for the pagination details. The deleteUser, deleteChannel, deleteMembership, deleteEntity, and deleteRelationship methods return a PNDataSyncDeleteResult that carries no data. The status key in each Response block below stands for the HTTP status code, which envelope() exposes through getStatus()->getStatusCode(), and the result doesn't surface the HATEOAS links the service adds to a response. A stored object carries its free-form status and its expiresAt auto-deletion timestamp (ISO 8601) whenever those are set on it, and the timestamps stay ISO 8601 strings rather than becoming DateTime objects.

Authorization

Every DataSync request must be authorized with a token or signature. A request with no credential fails with a 401; an invalid credential or a credential that doesn't permit the operation fails with a 403.

A signature means the client is configured with a secret key, and the SDK then signs every request with it automatically. Never put a secret key in a client-side application, use it only on a server you control. Give client-side applications a token from grantToken() instead, set with setToken().

Pagination

DataSync pagination is forward-only. There is no previous-page cursor, and PNDataSyncPage exposes no previous cursor or hasPrev. To revisit an earlier page, page from the start again.

All list methods (getUsers, getChannels, getMemberships, getEntities, and getRelationships) accept cursor and limit (default 20, max 100) and can return a PNDataSyncPage from getPage() with hasNext(), getNextCursor(), and getLimit(). The page is optional, so guard the access when you read it, for example $result->getPage()?->getNextCursor().

To page forward, pass the returned getNextCursor() value back as cursor on the next call, and stop when hasNext() is false. getNextCursor() is null on the last page. Refer to sorting and pagination for details.

Filtering and sorting

All list methods accept two mutually exclusive filter parameters, filterFast and filter. The SDK sends whatever you set, so a call that carries both reaches the server and fails there with a 400.

Parameter	Consistency	Properties it can read	Expression complexity
filterFast	Strongly consistent, reflects the latest writes	Filtering mode simple or full	Up to 10 conditions by default (raisable per keyset)
filter	Eventually consistent, results can briefly lag writes	Filtering mode full only	Full expression language

Reach for filterFast when the query has to see an object you just wrote, and for filter when you need the full expression language over a full-indexed property.

danger

filter is not the strongly consistent one

The two names read the wrong way round if you assume filter is the basic option. filterFast is the strongly consistent, limited one. filter is the richer, eventually consistent one.

Both parameters share the same expression language, a string built from a property name, an operator, and a value:

Operators
Comparison	==, !=, <, >, <=, >=
Pattern matching	LIKE (case-insensitive), SLIKE (case-sensitive), ILIKE (case-insensitive, same as LIKE)
Logical	&&, ||, !, and parentheses for grouping

Values are quoted strings, numbers, true, false, or null. Pattern operators (LIKE, SLIKE, ILIKE) apply to string properties only, and null is only valid with == and !=. Reference a property by its name, not its declared path, and only properties declared on the class are filterable. To reach a nested payload property, declare it as a class property first, then filter by that property's name, for example 'price < 100' for a product class that declares price.

Some examples:

1->filterFast('price < 100')                               // strongly consistent, single condition
2->filterFast('(price < 100 && stock > 0) || price > 500') // strongly consistent, grouped conditions
3->filter('name LIKE "*sneaker*"')                         // eventually consistent, needs filtering mode "full"
4->filter('!(status == "discontinued")')                   // eventually consistent, negated condition

Both parameters only work over properties declared on the class, plus the built-in id, createdAt, updatedAt, and status fields, which are always filterable and sortable without being declared. eTag and expiresAt are neither. The status exception does not hold if the class redeclares /status scoped to projections your token cannot fully reach. Refer to filtering for the two filtering tiers, and property definitions for how properties are declared.

Use sort to order results. Its value is a comma-separated list of fields, each a property name optionally suffixed with :asc or :desc. A bare name sorts ascending:

1->sort('price:desc')       // single field, descending
2->sort('type,price:desc')  // type ascending, then price descending
3->sort('createdAt:asc')    // explicit ascending

sort also accepts an array that the SDK joins into that string. A key is a property name and its value is 'asc' or 'desc', and a bare list entry sorts ascending. Fields are joined in the order they appear:

1->sort(['type', 'price' => 'desc']) // same order as 'type,price:desc'

The +field and -field prefixes are not accepted. A leading - is read as part of the property name, so '-price' fails with a 400. Only properties declared on the class with a filtering mode other than none can be sorted on when sorting alone or alongside filterFast. Sorting alongside filter additionally requires the field to be declared full. The built-in fields id, createdAt, updatedAt, and status are always sortable without declaring them on the class.

The SDK doesn't validate filterFast, filter, or limit locally, it passes them through as-is, and it passes a sort string through untouched. An invalid expression, an unsortable field, or an out-of-range limit only surfaces as an error response from the server. The one exception is an array sort whose direction is neither asc nor desc, which throws a PubNubValidationException before anything is sent, because the server would otherwise silently drop the direction and sort the other way.

Concurrency (ETag)

Every stored object carries an ETag. To guard against concurrent writes, pass the ETag you read earlier as ifMatchesETag on set*, update*, and delete* calls. The SDK sends it as the If-Match request header.

If the server-side value has changed in the meantime, the operation fails with a 412, and you should re-read the object and retry. Refer to optimistic concurrency with ETags for details.

With sync(), the 412 arrives as a PubNubServerException, and getStatusCode() returns it.

Partial updates

The update* methods apply a partial update using raw JSON Patch (RFC 6902). Build the operations by chaining add, remove, replace, move, copy, and test on a PNDataSyncPatch and pass it to patch, or pass a raw array of operations instead. Each raw operation has an op (add, remove, replace, move, copy, or test), a path (a full JSON Pointer, for example /status or /payload/price), and, depending on the operation, a value or a from.

Each path is a full JSON Pointer (RFC 6901) and is sent as you write it. The SDK does not add a /payload prefix. To target a field inside payload, include the prefix yourself, for example /payload/price, not /price. A bare /price targets a top-level field named price, which doesn't exist. Top-level fields like /status can be patched directly. Refer to partial update for details.

Correct patch forms:

1->add('/payload/tags', 'sale')                // adds a value inside payload.tags
2->replace('/payload/price', 79.99)            // replaces payload.price
3->remove('/payload/tempFlag')                 // removes payload.tempFlag
4->move('/payload/oldTag', '/payload/tag')
5->copy('/payload/price', '/payload/msrp')
6->test('/status', 'active')                   // fails the patch if the current value doesn't match

move and copy take the source pointer first and the target pointer second, instead of a value. test fails the entire patch if the current value at its path doesn't match, use it to guard the rest of the operations against a stale read.

Paths address the object's stored property names, the same keys that come back in responses. The class version is entityClassVersion on users, channels, and entities, and relationshipClassVersion on memberships and relationships. The fields set at creation cannot be patched: entityClass and entityClassLevel on users, channels, and entities, relationshipClass, entityAId, and entityBId on relationships, and userId and channelId on memberships.

All operations in the call apply together or not at all.

The patch must contain at least one operation. The SDK checks this before it sends anything and throws a PubNubValidationException if the builder is empty or the array has no operations. For a raw array, it also checks that every operation has an op and a path, a value for add, replace, and test, and a from for move and copy.

Expiry (TTL)

An object's expiresAt is computed once when the object is created, and updates never refresh it. The value is the creation time plus the class TTL, rounded up to the start of the next whole UTC day, so it rarely lands exactly one TTL from the moment you wrote the object.

Entity classes you create default to a 31-day TTL, while the built-in Global User and Channel classes use 30 days. TTL cannot be disabled. A relationship expires at the earlier expiry time of the two entities it links, fixed when the relationship is created.

Refer to data expiry for details.

Synchronous calls, two ways to read the outcome

Every DataSync method is a fluent builder that you finish with sync() or envelope(), and the request blocks until it completes. sync() returns the typed result and throws on failure: a PubNubValidationException for a missing or invalid argument, checked before anything is sent (for example a missing id, an entityClassVersion below 1, or a missing entityClass on entities), and a PubNubServerException when the service answers with an error, where getStatusCode() returns the HTTP status. envelope() returns a PNEnvelope and never throws for a server error, so call isError() first, then read getResult() or getStatus(). It also skips the argument checks, so the service rejects an invalid request instead. The samples use sync().

Requires Access Manager

DataSync requires that the Access Manager add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.

Users

Users are built-in objects. There are no top-level name or email fields, all application data lives in the free-form payload. Refer to users for the concept.

A user is an entity of the built-in User entity class, which the service provides at the Global class level. To give your users their own declared, filterable properties, define a subclass of User with Create a new entity class and pass its name as entityClass.

Create user

Creates a user. Supply an userId to control the identifier, or omit it to let the server generate one.

Method(s)

1$pubnub->dataSync()->createUser()
2    ->userId(string)
3    ->entityClass(string)
4    ->entityClassVersion(int)
5    ->entityClassLevel(string)
6    ->status(string)
7    ->payload(array)
8    ->sync(); // PNDataSyncUserResult

* required

Parameter	Description
userId Type: string Default: server-generated	User identifier. Omit to let the server generate a UUID. Max 255 characters.
entityClass Type: string Default: User	Name of the entity class this user belongs to. Must be User or one of its subclasses. Defaults to User on the server if omitted. Set at creation and immutable afterward.
entityClassVersion * Type: int Default: n/a	Version of the user class schema.
entityClassLevel Type: string Default: service default	Class hierarchy level of entityClass, either Global for a class the service provides or SubKey for one defined on your keyset. Used to disambiguate classes with the same name defined at different levels. Set at creation and immutable afterward.
status Type: string Default: n/a	Free-form lifecycle status. Max 100 characters.
payload Type: array Default: n/a	Free-form JSON object holding your application data.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 201,
3    "data": {
4        "id": "user-alice",
5        "entityClass": "User",
6        "entityClassVersion": 1,
7        "entityClassLevel": "Global",
8        "payload": { "name": "Alice", "type": "shopper" },
9        "createdAt": "2026-07-13T09:00:00.000Z",
10        "updatedAt": "2026-07-13T09:00:00.000Z",
11        "eTag": "AbCdEfGhIjKlMn"
12    }
13}

Get user

Returns a single user by userId.

Method(s)

1$pubnub->dataSync()->getUser()
2    ->userId(string)
3    ->sync(); // PNDataSyncUserResult

* required

Parameter	Description
userId * Type: string Default: n/a	User identifier.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200,
3    "data": {
4        "id": "user-alice",
5        "entityClass": "User",
6        "entityClassVersion": 1,
7        "entityClassLevel": "Global",
8        "payload": { "name": "Alice", "type": "shopper" },
9        "createdAt": "2026-07-13T09:00:00.000Z",
10        "updatedAt": "2026-07-13T09:00:00.000Z",
11        "eTag": "AbCdEfGhIjKlMn"
12    }
13}

Get all users

Returns a paginated list of users. All parameters are optional, so you can call getUsers and finish with sync() straight away. For pagination, filtering, and sorting, refer to sorting and pagination.

Method(s)

1$pubnub->dataSync()->getUsers()
2    ->entityClass(string)
3    ->entityClassVersion(int)
4    ->entityClassLevel(string)
5    ->cursor(string)
6    ->limit(int)
7    ->filterFast(string)
8    ->filter(string)
9    ->sort(string|array)
10    ->sync(); // PNDataSyncUsersResult

* required

Parameter	Description
entityClass Type: string Default: all user classes	User class to list. Omit to list the Global User class and all of its subclasses.
entityClassVersion Type: int Default: all versions	User class version to list. Omit to list users across every version of the class.
entityClassLevel Type: string Default: service default	Class hierarchy level of entityClass, either Global for a class the service provides or SubKey for one defined on your keyset. Used to disambiguate a class name defined at both levels.
cursor Type: string Default: n/a	Opaque pagination cursor. Omit for the first page.
limit Type: int Default: 20	Maximum number of users per page. Max 100.
filterFast Type: string Default: n/a	Filter expression evaluated against strongly consistent storage, so it reflects the latest writes. Accepts up to 10 conditions by default (raisable per keyset), over properties declared with filtering mode simple or full. Cannot be combined with filter.
filter Type: string Default: n/a	Filter expression evaluated against eventually consistent storage, so results can briefly lag writes. Supports the full expression language, over properties declared with filtering mode full. Cannot be combined with filterFast.
sort Type: string | array Default: n/a	Order results. Pass a string of fields each optionally suffixed with :asc or :desc, or an array that the SDK joins into one, for example 'createdAt:desc'.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200,
3    "data": [
4        {
5            "id": "user-alice",
6            "entityClass": "User",
7            "entityClassVersion": 1,
8            "entityClassLevel": "Global",
9            "payload": { "name": "Alice", "type": "shopper" },
10            "createdAt": "2026-07-13T09:00:00.000Z",
11            "updatedAt": "2026-07-13T09:00:00.000Z",
12            "eTag": "AbCdEfGhIjKlMn"
13        }
14    ],
15    "meta": {
16        "next_cursor": "b2Zmc2V0PTIw",
17        "has_next": true,
18        "limit": 20
19    }
20}

show all 20 lines

Other examples

Filter with filterFast

filterFast is evaluated against strongly consistent storage, so it matches an object you just wrote. It runs over properties declared with filtering mode simple or full and accepts up to 10 conditions by default (raisable per keyset). Reference a declared property by its name, not its path. It shares the same expression language as filter, so only one of the two can be sent per call.

1

Filter with filter

filter runs over properties declared with filtering mode full and is evaluated against eventually consistent storage, so a very recent write may not be matched yet. Reference a declared property by its name, not its path. It shares the same expression language as filterFast, so only one of the two can be sent per call.

1

Page through results with cursor

Pass no cursor on the first call. Take getPage()->getNextCursor() from the result and pass it back as cursor on the next call. Stop when getPage()->hasNext() is false.

1

Set user

Replaces a user in full (PUT). Send the complete set of fields, any field you omit is cleared. entityClass is immutable after creation and cannot be sent. Refer to optimistic concurrency with ETags for ifMatchesETag. For a partial update, use Update user.

Method(s)

1$pubnub->dataSync()->setUser()
2    ->userId(string)
3    ->entityClassVersion(int)
4    ->status(string)
5    ->payload(array)
6    ->ifMatchesETag(string)
7    ->sync(); // PNDataSyncUserResult

* required

Parameter	Description
userId * Type: string Default: n/a	User identifier.
entityClassVersion * Type: int Default: n/a	Version of the user class schema.
status Type: string Default: n/a	Free-form lifecycle status. Max 100 characters.
payload Type: array Default: n/a	Free-form JSON object holding your application data.
ifMatchesETag Type: string Default: n/a	The ETag from a prior read. The update succeeds only if it still matches, otherwise the server returns 412.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200,
3    "data": {
4        "id": "user-alice",
5        "entityClass": "User",
6        "entityClassVersion": 1,
7        "entityClassLevel": "Global",
8        "payload": { "name": "Alice B.", "type": "shopper" },
9        "createdAt": "2026-07-13T09:00:00.000Z",
10        "updatedAt": "2026-07-13T10:15:00.000Z",
11        "eTag": "CdEfGhIjKlMnOp"
12    }
13}

Update user

Applies a partial update to a user with raw JSON Patch operations. Refer to partial update for the operation model.

Method(s)

1$pubnub->dataSync()->updateUser()
2    ->userId(string)
3    ->patch(PNDataSyncPatch|array)
4    ->ifMatchesETag(string)
5    ->sync(); // PNDataSyncUserResult

* required

Parameter	Description
userId * Type: string Default: n/a	User identifier.
patch * Type: PNDataSyncPatch | array Default: n/a	One or more JSON Patch operations. Must contain at least one item. Pass a PNDataSyncPatch builder or a raw array of RFC 6902 operations.
ifMatchesETag Type: string Default: n/a	The ETag from a prior read. The patch succeeds only if it still matches, otherwise the server returns 412.

Use a JSON Pointer that starts with /payload/ to target payload fields, or a root pointer (for example /status) to target a top-level field.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200,
3    "data": {
4        "id": "user-alice",
5        "status": "active",
6        "entityClass": "User",
7        "entityClassVersion": 1,
8        "entityClassLevel": "Global",
9        "payload": { "name": "Alice B.", "type": "shopper" },
10        "createdAt": "2026-07-13T09:00:00.000Z",
11        "updatedAt": "2026-07-13T10:20:00.000Z",
12        "eTag": "EfGhIjKlMnOpQr"
13    }
14}

Remove user

Deletes a user by userId.

Method(s)

1$pubnub->dataSync()->deleteUser()
2    ->userId(string)
3    ->ifMatchesETag(string)
4    ->sync(); // PNDataSyncDeleteResult

* required

Parameter	Description
userId * Type: string Default: n/a	User identifier.
ifMatchesETag Type: string Default: n/a	The ETag from a prior read. The delete succeeds only if it still matches, otherwise the server returns 412.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200
3}

Channels

Channels work like users. They have no top-level name field, all application data lives in payload, and they support the same operations. Refer to channels for the concept.

A channel is an entity of the built-in Channel entity class, which the service provides at the Global class level. Subclass it with Create a new entity class to add declared properties, then pass the subclass name as entityClass.

Create channel

Creates a channel. Supply an channelId to control the identifier, or omit it to let the server generate one.

Method(s)

1$pubnub->dataSync()->createChannel()
2    ->channelId(string)
3    ->entityClass(string)
4    ->entityClassVersion(int)
5    ->entityClassLevel(string)
6    ->status(string)
7    ->payload(array)
8    ->sync(); // PNDataSyncChannelResult

* required

Parameter	Description
channelId Type: string Default: server-generated	Channel identifier. Omit to let the server generate a UUID. Max 255 characters.
entityClass Type: string Default: Channel	Name of the entity class this channel belongs to. Must be Channel or one of its subclasses. Defaults to Channel on the server if omitted. Set at creation and immutable afterward.
entityClassVersion * Type: int Default: n/a	Version of the channel class schema.
entityClassLevel Type: string Default: service default	Class hierarchy level of entityClass, either Global for a class the service provides or SubKey for one defined on your keyset. Used to disambiguate classes with the same name defined at different levels. Set at creation and immutable afterward.
status Type: string Default: n/a	Free-form lifecycle status. Max 100 characters.
payload Type: array Default: n/a	Free-form JSON object holding your application data.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 201,
3    "data": {
4        "id": "channel-summer-sale",
5        "entityClass": "Channel",
6        "entityClassVersion": 1,
7        "entityClassLevel": "Global",
8        "payload": { "name": "Summer Sale", "type": "promotion" },
9        "createdAt": "2026-07-13T09:05:00.000Z",
10        "updatedAt": "2026-07-13T09:05:00.000Z",
11        "eTag": "GhIjKlMnOpQrSt"
12    }
13}

Get channel

Returns a single channel by channelId.

Method(s)

1$pubnub->dataSync()->getChannel()
2    ->channelId(string)
3    ->sync(); // PNDataSyncChannelResult

* required

Parameter	Description
channelId * Type: string Default: n/a	Channel identifier.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200,
3    "data": {
4        "id": "channel-summer-sale",
5        "entityClass": "Channel",
6        "entityClassVersion": 1,
7        "entityClassLevel": "Global",
8        "payload": { "name": "Summer Sale", "type": "promotion" },
9        "createdAt": "2026-07-13T09:05:00.000Z",
10        "updatedAt": "2026-07-13T09:05:00.000Z",
11        "eTag": "GhIjKlMnOpQrSt"
12    }
13}

Get all channels

Returns a paginated list of channels. All parameters are optional, so you can call getChannels and finish with sync() straight away. For pagination, filtering, and sorting, refer to sorting and pagination.

Method(s)

1$pubnub->dataSync()->getChannels()
2    ->entityClass(string)
3    ->entityClassVersion(int)
4    ->entityClassLevel(string)
5    ->cursor(string)
6    ->limit(int)
7    ->filterFast(string)
8    ->filter(string)
9    ->sort(string|array)
10    ->sync(); // PNDataSyncChannelsResult

* required

Parameter	Description
entityClass Type: string Default: all channel classes	Channel class to list. Omit to list the Global Channel class and all of its subclasses.
entityClassVersion Type: int Default: all versions	Channel class version to list. Omit to list channels across every version of the class.
entityClassLevel Type: string Default: service default	Class hierarchy level of entityClass, either Global for a class the service provides or SubKey for one defined on your keyset. Used to disambiguate a class name defined at both levels.
cursor Type: string Default: n/a	Opaque pagination cursor. Omit for the first page.
limit Type: int Default: 20	Maximum number of channels per page. Max 100.
filterFast Type: string Default: n/a	Filter expression evaluated against strongly consistent storage, so it reflects the latest writes. Accepts up to 10 conditions by default (raisable per keyset), over properties declared with filtering mode simple or full. Cannot be combined with filter.
filter Type: string Default: n/a	Filter expression evaluated against eventually consistent storage, so results can briefly lag writes. Supports the full expression language, over properties declared with filtering mode full. Cannot be combined with filterFast.
sort Type: string | array Default: n/a	Order results. Pass a string of fields each optionally suffixed with :asc or :desc, or an array that the SDK joins into one.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200,
3    "data": [
4        {
5            "id": "channel-summer-sale",
6            "entityClass": "Channel",
7            "entityClassVersion": 1,
8            "entityClassLevel": "Global",
9            "payload": { "name": "Summer Sale", "type": "promotion" },
10            "createdAt": "2026-07-13T09:05:00.000Z",
11            "updatedAt": "2026-07-13T09:05:00.000Z",
12            "eTag": "GhIjKlMnOpQrSt"
13        }
14    ],
15    "meta": {
16        "next_cursor": null,
17        "has_next": false,
18        "limit": 20
19    }
20}

show all 20 lines

Other examples

Filter with filterFast

filterFast is evaluated against strongly consistent storage, so it matches an object you just wrote. It runs over properties declared with filtering mode simple or full and accepts up to 10 conditions by default (raisable per keyset). Reference a declared property by its name, not its path. It shares the same expression language as filter, so only one of the two can be sent per call.

1

Filter with filter

filter runs over properties declared with filtering mode full and is evaluated against eventually consistent storage, so a very recent write may not be matched yet. Reference a declared property by its name, not its path. It shares the same expression language as filterFast, so only one of the two can be sent per call.

1

Page through results with cursor

Pass no cursor on the first call. Take getPage()->getNextCursor() from the result and pass it back as cursor on the next call. Stop when getPage()->hasNext() is false.

1

Set channel

Replaces a channel in full (PUT). Send the complete set of fields, any field you omit is cleared. entityClass is immutable after creation and cannot be sent. Refer to optimistic concurrency with ETags for ifMatchesETag. For a partial update, use Update channel.

Method(s)

1$pubnub->dataSync()->setChannel()
2    ->channelId(string)
3    ->entityClassVersion(int)
4    ->status(string)
5    ->payload(array)
6    ->ifMatchesETag(string)
7    ->sync(); // PNDataSyncChannelResult

* required

Parameter	Description
channelId * Type: string Default: n/a	Channel identifier.
entityClassVersion * Type: int Default: n/a	Version of the channel class schema.
status Type: string Default: n/a	Free-form lifecycle status. Max 100 characters.
payload Type: array Default: n/a	Free-form JSON object holding your application data.
ifMatchesETag Type: string Default: n/a	The ETag from a prior read. The update succeeds only if it still matches, otherwise the server returns 412.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200,
3    "data": {
4        "id": "channel-summer-sale",
5        "entityClass": "Channel",
6        "entityClassVersion": 1,
7        "entityClassLevel": "Global",
8        "payload": { "name": "Summer Sale 2026", "type": "promotion" },
9        "createdAt": "2026-07-13T09:05:00.000Z",
10        "updatedAt": "2026-07-13T11:00:00.000Z",
11        "eTag": "IjKlMnOpQrStUv"
12    }
13}

Update channel

Applies a partial update to a channel with raw JSON Patch operations. Refer to partial update for the operation model.

Method(s)

1$pubnub->dataSync()->updateChannel()
2    ->channelId(string)
3    ->patch(PNDataSyncPatch|array)
4    ->ifMatchesETag(string)
5    ->sync(); // PNDataSyncChannelResult

* required

Parameter	Description
channelId * Type: string Default: n/a	Channel identifier.
patch * Type: PNDataSyncPatch | array Default: n/a	One or more JSON Patch operations. Must contain at least one item. Pass a PNDataSyncPatch builder or a raw array of RFC 6902 operations.
ifMatchesETag Type: string Default: n/a	The ETag from a prior read. The patch succeeds only if it still matches, otherwise the server returns 412.

Use a JSON Pointer that starts with /payload/ to target payload fields, or a root pointer (for example /status) to target a top-level field.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200,
3    "data": {
4        "id": "channel-summer-sale",
5        "status": "active",
6        "entityClass": "Channel",
7        "entityClassVersion": 1,
8        "entityClassLevel": "Global",
9        "payload": { "name": "Summer Sale 2026", "type": "promotion" },
10        "createdAt": "2026-07-13T09:05:00.000Z",
11        "updatedAt": "2026-07-13T11:05:00.000Z",
12        "eTag": "KlMnOpQrStUvWx"
13    }
14}

Remove channel

Deletes a channel by channelId.

Method(s)

1$pubnub->dataSync()->deleteChannel()
2    ->channelId(string)
3    ->ifMatchesETag(string)
4    ->sync(); // PNDataSyncDeleteResult

* required

Parameter	Description
channelId * Type: string Default: n/a	Channel identifier.
ifMatchesETag Type: string Default: n/a	The ETag from a prior read. The delete succeeds only if it still matches, otherwise the server returns 412.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200
3}

Memberships

A membership links a user to a channel and carries its own payload. In the running example, Alice is a member of channel-summer-sale with the payload { "role": "viewer" }. Refer to memberships for the concept.

A membership is a relationship of the built-in Global Membership relationship class, whose two sides are surfaced as channelId and userId. Every membership response includes both relationshipClass and relationshipClassVersion. The class is assigned by the service, so the createMembership and setMembership methods take no class parameter.

Relationship classes don't support inheritance, and only the Global Membership class produces memberships, so relationshipClass is always Membership and relationshipClassVersion is the only part that varies.

Create membership

Creates a membership linking a user to a channel. The userId/channelId pair must be unique for the membership class. A membership that duplicates an existing pair is rejected with a 409.

Method(s)

1$pubnub->dataSync()->createMembership()
2    ->membershipId(string)
3    ->channelId(string)
4    ->userId(string)
5    ->relationshipClassVersion(int)
6    ->status(string)
7    ->payload(array)
8    ->sync(); // PNDataSyncMembershipResult

* required

Parameter	Description
membershipId Type: string Default: server-generated	Membership identifier. Omit to let the server generate a UUID. Max 255 characters.
channelId * Type: string Default: n/a	Identifier of the channel in the membership.
userId * Type: string Default: n/a	Identifier of the user in the membership.
relationshipClassVersion * Type: int Default: n/a	Version of the Membership relationship class schema.
status Type: string Default: n/a	Free-form lifecycle status. Max 100 characters.
payload Type: array Default: n/a	Free-form JSON object holding your application data.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 201,
3    "data": {
4        "id": "membership-alice-summer-sale",
5        "channelId": "channel-summer-sale",
6        "userId": "user-alice",
7        "relationshipClass": "Membership",
8        "relationshipClassVersion": 1,
9        "payload": { "role": "viewer" },
10        "createdAt": "2026-07-13T09:10:00.000Z",
11        "updatedAt": "2026-07-13T09:10:00.000Z",
12        "eTag": "MnOpQrStUvWxYz"
13    }
14}

Get membership

Returns a single membership by membershipId.

Method(s)

1$pubnub->dataSync()->getMembership()
2    ->membershipId(string)
3    ->sync(); // PNDataSyncMembershipResult

* required

Parameter	Description
membershipId * Type: string Default: n/a	Membership identifier.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200,
3    "data": {
4        "id": "membership-alice-summer-sale",
5        "channelId": "channel-summer-sale",
6        "userId": "user-alice",
7        "relationshipClass": "Membership",
8        "relationshipClassVersion": 1,
9        "payload": { "role": "viewer" },
10        "createdAt": "2026-07-13T09:10:00.000Z",
11        "updatedAt": "2026-07-13T09:10:00.000Z",
12        "eTag": "MnOpQrStUvWxYz"
13    }
14}

Get all memberships

Returns a paginated list of memberships. All parameters are optional, so you can call getMemberships and finish with sync() straight away. userId and channelId can be set independently, together, or omitted entirely. Filter by userId to list a user's memberships or by channelId to list a channel's members. For pagination, filtering, and sorting, refer to sorting and pagination.

Method(s)

1$pubnub->dataSync()->getMemberships()
2    ->userId(string)
3    ->channelId(string)
4    ->relationshipClassVersion(int)
5    ->cursor(string)
6    ->limit(int)
7    ->filterFast(string)
8    ->filter(string)
9    ->sort(string|array)
10    ->sync(); // PNDataSyncMembershipsResult

* required

Parameter	Description
userId Type: string Default: n/a	List only memberships for this user.
channelId Type: string Default: n/a	List only memberships for this channel.
relationshipClassVersion Type: int Default: all versions	Membership class version to list. Omit to list memberships across every version of the class.
cursor Type: string Default: n/a	Opaque pagination cursor. Omit for the first page.
limit Type: int Default: 20	Maximum number of memberships per page. Max 100.
filterFast Type: string Default: n/a	Filter expression evaluated against strongly consistent storage, so it reflects the latest writes. Accepts up to 10 conditions by default (raisable per keyset), over properties declared with filtering mode simple or full. Cannot be combined with filter.
filter Type: string Default: n/a	Filter expression evaluated against eventually consistent storage, so results can briefly lag writes. Supports the full expression language, over properties declared with filtering mode full. Cannot be combined with filterFast.
sort Type: string | array Default: n/a	Order results. Pass a string of fields each optionally suffixed with :asc or :desc, or an array that the SDK joins into one.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200,
3    "data": [
4        {
5            "id": "membership-alice-summer-sale",
6            "channelId": "channel-summer-sale",
7            "userId": "user-alice",
8            "relationshipClass": "Membership",
9            "relationshipClassVersion": 1,
10            "payload": { "role": "viewer" },
11            "createdAt": "2026-07-13T09:10:00.000Z",
12            "updatedAt": "2026-07-13T09:10:00.000Z",
13            "eTag": "MnOpQrStUvWxYz"
14        }
15    ],
16    "meta": {
17        "next_cursor": null,
18        "has_next": false,
19        "limit": 20
20    }
21}

show all 21 lines

Other examples

List a channel's members with channelId

Pass channelId instead of userId to list the members of a channel rather than a user's memberships.

1

Filter with filterFast

filterFast is evaluated against strongly consistent storage, so it matches an object you just wrote. It runs over properties declared with filtering mode simple or full and accepts up to 10 conditions by default (raisable per keyset). Reference a declared property by its name, not its path. It shares the same expression language as filter, so only one of the two can be sent per call.

1

Filter with filter

filter runs over properties declared with filtering mode full and is evaluated against eventually consistent storage, so a very recent write may not be matched yet. Reference a declared property by its name, not its path. It shares the same expression language as filterFast, so only one of the two can be sent per call.

1

Page through results with cursor

Pass no cursor on the first call. Take getPage()->getNextCursor() from the result and pass it back as cursor on the next call. Stop when getPage()->hasNext() is false.

1

Set membership

Replaces a membership in full (PUT). Send the complete set of fields, any field you omit is cleared. The linked user and channel ids are immutable, so setMembership doesn't expose userId/channelId at all, there's nothing to resend. Refer to optimistic concurrency with ETags for ifMatchesETag. For a partial update, use Update membership.

Method(s)

1$pubnub->dataSync()->setMembership()
2    ->membershipId(string)
3    ->relationshipClassVersion(int)
4    ->status(string)
5    ->payload(array)
6    ->ifMatchesETag(string)
7    ->sync(); // PNDataSyncMembershipResult

* required

Parameter	Description
membershipId * Type: string Default: n/a	Membership identifier.
relationshipClassVersion * Type: int Default: n/a	Version of the Membership relationship class schema.
status Type: string Default: n/a	Free-form lifecycle status. Max 100 characters.
payload Type: array Default: n/a	Free-form JSON object holding your application data.
ifMatchesETag Type: string Default: n/a	The ETag from a prior read. The update succeeds only if it still matches, otherwise the server returns 412.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200,
3    "data": {
4        "id": "membership-alice-summer-sale",
5        "channelId": "channel-summer-sale",
6        "userId": "user-alice",
7        "relationshipClass": "Membership",
8        "relationshipClassVersion": 1,
9        "payload": { "role": "moderator" },
10        "createdAt": "2026-07-13T09:10:00.000Z",
11        "updatedAt": "2026-07-13T12:00:00.000Z",
12        "eTag": "OpQrStUvWxYzAb"
13    }
14}

Update membership

Applies a partial update to a membership with raw JSON Patch operations. Refer to partial update for the operation model.

Method(s)

1$pubnub->dataSync()->updateMembership()
2    ->membershipId(string)
3    ->patch(PNDataSyncPatch|array)
4    ->ifMatchesETag(string)
5    ->sync(); // PNDataSyncMembershipResult

* required

Parameter	Description
membershipId * Type: string Default: n/a	Membership identifier.
patch * Type: PNDataSyncPatch | array Default: n/a	One or more JSON Patch operations. Must contain at least one item. Pass a PNDataSyncPatch builder or a raw array of RFC 6902 operations.
ifMatchesETag Type: string Default: n/a	The ETag from a prior read. The patch succeeds only if it still matches, otherwise the server returns 412.

Use a JSON Pointer that starts with /payload/ to target payload fields, or a root pointer (for example /status) to target a top-level field.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200,
3    "data": {
4        "id": "membership-alice-summer-sale",
5        "status": "active",
6        "channelId": "channel-summer-sale",
7        "userId": "user-alice",
8        "relationshipClass": "Membership",
9        "relationshipClassVersion": 1,
10        "payload": { "role": "moderator" },
11        "createdAt": "2026-07-13T09:10:00.000Z",
12        "updatedAt": "2026-07-13T12:05:00.000Z",
13        "eTag": "QrStUvWxYzAbCd"
14    }
15}

Remove membership

Deletes a membership by membershipId.

Method(s)

1$pubnub->dataSync()->deleteMembership()
2    ->membershipId(string)
3    ->ifMatchesETag(string)
4    ->sync(); // PNDataSyncDeleteResult

* required

Parameter	Description
membershipId * Type: string Default: n/a	Membership identifier.
ifMatchesETag Type: string Default: n/a	The ETag from a prior read. The delete succeeds only if it still matches, otherwise the server returns 412.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200
3}

Entities

Entities are instances of the custom entity classes you define on your keyset. In the running example, product is a class and product-sneaker-42 is an instance. Use Create a new entity class to declare a class, and Get entity class by ID to read the property, filtering, and projection declarations that govern its instances.

Entity classes can extend one another. Listing a class also returns the entities of its subclasses, so getEntities()->entityClass('product') returns every product plus every instance of a class that extends product.

Create entity

Creates an entity of a given class and version.

Method(s)

1$pubnub->dataSync()->createEntity()
2    ->entityId(string)
3    ->entityClass(string)
4    ->entityClassVersion(int)
5    ->entityClassLevel(string)
6    ->status(string)
7    ->payload(array)
8    ->sync(); // PNDataSyncEntityResult

* required

Parameter	Description
entityId Type: string Default: server-generated	Entity identifier. Omit to let the server generate a UUID. Max 255 characters.
entityClass * Type: string Default: n/a	Name of the entity class this instance belongs to. Set at creation and immutable afterward.
entityClassVersion * Type: int Default: n/a	Version of the entity class schema.
entityClassLevel Type: string Default: service default	Class hierarchy level of entityClass, either Global for a class the service provides or SubKey for one defined on your keyset. Used to disambiguate classes with the same name defined at different levels. Set at creation and immutable afterward.
status Type: string Default: n/a	Free-form lifecycle status. Max 100 characters.
payload Type: array Default: n/a	Free-form JSON object holding your application data.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 201,
3    "data": {
4        "id": "product-sneaker-42",
5        "entityClass": "product",
6        "entityClassVersion": 1,
7        "entityClassLevel": "SubKey",
8        "payload": { "name": "Retro Sneaker", "price": 89.99, "stock": 12 },
9        "createdAt": "2026-07-13T09:15:00.000Z",
10        "updatedAt": "2026-07-13T09:15:00.000Z",
11        "eTag": "StUvWxYzAbCdEf"
12    }
13}

Get entity

Returns a single entity by entityId.

Method(s)

1$pubnub->dataSync()->getEntity()
2    ->entityId(string)
3    ->sync(); // PNDataSyncEntityResult

* required

Parameter	Description
entityId * Type: string Default: n/a	Entity identifier.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200,
3    "data": {
4        "id": "product-sneaker-42",
5        "entityClass": "product",
6        "entityClassVersion": 1,
7        "entityClassLevel": "SubKey",
8        "payload": { "name": "Retro Sneaker", "price": 89.99, "stock": 12 },
9        "createdAt": "2026-07-13T09:15:00.000Z",
10        "updatedAt": "2026-07-13T09:15:00.000Z",
11        "eTag": "StUvWxYzAbCdEf"
12    }
13}

Get all entities

Returns a paginated list of entities within a class. The entityClass parameter is required, entities are always listed within the context of their class. For pagination, filtering, and sorting, refer to sorting and pagination.

Method(s)

1$pubnub->dataSync()->getEntities()
2    ->entityClass(string)
3    ->entityClassVersion(int)
4    ->entityClassLevel(string)
5    ->cursor(string)
6    ->limit(int)
7    ->filterFast(string)
8    ->filter(string)
9    ->sort(string|array)
10    ->sync(); // PNDataSyncEntitiesResult

* required

Parameter	Description
entityClass * Type: string Default: n/a	Name of the entity class to list.
entityClassVersion Type: int Default: all versions	Entity class version to list. Omit to list entities across every version of the class.
entityClassLevel Type: string Default: service default	Class hierarchy level of entityClass, either Global for a class the service provides or SubKey for one defined on your keyset. Used to disambiguate a class name defined at both levels.
cursor Type: string Default: n/a	Opaque pagination cursor. Omit for the first page.
limit Type: int Default: 20	Maximum number of entities per page. Max 100.
filterFast Type: string Default: n/a	Filter expression evaluated against strongly consistent storage, so it reflects the latest writes. Accepts up to 10 conditions by default (raisable per keyset), over properties declared with filtering mode simple or full. Cannot be combined with filter.
filter Type: string Default: n/a	Filter expression evaluated against eventually consistent storage, so results can briefly lag writes. Supports the full expression language, over properties declared with filtering mode full. Cannot be combined with filterFast.
sort Type: string | array Default: n/a	Order results. Pass a string of fields each optionally suffixed with :asc or :desc, or an array that the SDK joins into one.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200,
3    "data": [
4        {
5            "id": "product-sneaker-42",
6            "entityClass": "product",
7            "entityClassVersion": 1,
8            "entityClassLevel": "SubKey",
9            "payload": { "name": "Retro Sneaker", "price": 89.99, "stock": 12 },
10            "createdAt": "2026-07-13T09:15:00.000Z",
11            "updatedAt": "2026-07-13T09:15:00.000Z",
12            "eTag": "StUvWxYzAbCdEf"
13        }
14    ],
15    "meta": {
16        "next_cursor": null,
17        "has_next": false,
18        "limit": 20
19    }
20}

show all 20 lines

Other examples

Filter with filterFast

filterFast is evaluated against strongly consistent storage, so it matches an object you just wrote. It runs over properties declared with filtering mode simple or full and accepts up to 10 conditions by default (raisable per keyset). Reference a declared property by its name, not its path, and combine conditions with && and ||. It shares the same expression language as filter, so only one of the two can be sent per call.

1

Filter with filter

filter runs over properties declared with filtering mode full and is evaluated against eventually consistent storage, so a very recent write may not be matched yet. Reference a declared property by its name, not its path, and combine conditions with && and ||. It shares the same expression language as filterFast, so only one of the two can be sent per call.

1

Page through results with cursor

Pass no cursor on the first call. Take getPage()->getNextCursor() from the result and pass it back as cursor on the next call. Stop when getPage()->hasNext() is false.

1

Set entity

Replaces an entity in full (PUT). Send the complete set of fields, any field you omit is cleared. entityClass is immutable after creation and cannot be sent. Refer to optimistic concurrency with ETags for ifMatchesETag. For a partial update, use Update entity.

Method(s)

1$pubnub->dataSync()->setEntity()
2    ->entityId(string)
3    ->entityClassVersion(int)
4    ->status(string)
5    ->payload(array)
6    ->ifMatchesETag(string)
7    ->sync(); // PNDataSyncEntityResult

* required

Parameter	Description
entityId * Type: string Default: n/a	Entity identifier.
entityClassVersion * Type: int Default: n/a	Version of the entity class schema.
status Type: string Default: n/a	Free-form lifecycle status. Max 100 characters.
payload Type: array Default: n/a	Free-form JSON object holding your application data.
ifMatchesETag Type: string Default: n/a	The ETag from a prior read. The update succeeds only if it still matches, otherwise the server returns 412.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200,
3    "data": {
4        "id": "product-sneaker-42",
5        "entityClass": "product",
6        "entityClassVersion": 1,
7        "entityClassLevel": "SubKey",
8        "payload": { "name": "Retro Sneaker", "price": 79.99, "stock": 12 },
9        "createdAt": "2026-07-13T09:15:00.000Z",
10        "updatedAt": "2026-07-13T13:00:00.000Z",
11        "eTag": "UvWxYzAbCdEfGh"
12    }
13}

Update entity

Applies a partial update to an entity with raw JSON Patch operations. Refer to partial update for the operation model.

Method(s)

1$pubnub->dataSync()->updateEntity()
2    ->entityId(string)
3    ->patch(PNDataSyncPatch|array)
4    ->ifMatchesETag(string)
5    ->sync(); // PNDataSyncEntityResult

* required

Parameter	Description
entityId * Type: string Default: n/a	Entity identifier.
patch * Type: PNDataSyncPatch | array Default: n/a	One or more JSON Patch operations. Must contain at least one item. Pass a PNDataSyncPatch builder or a raw array of RFC 6902 operations.
ifMatchesETag Type: string Default: n/a	The ETag from a prior read. The patch succeeds only if it still matches, otherwise the server returns 412.

Use a JSON Pointer that starts with /payload/ to target payload fields, or a root pointer (for example /status) to target a top-level field.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200,
3    "data": {
4        "id": "product-sneaker-42",
5        "entityClass": "product",
6        "entityClassVersion": 1,
7        "entityClassLevel": "SubKey",
8        "payload": { "name": "Retro Sneaker", "price": 79.99, "stock": 8 },
9        "createdAt": "2026-07-13T09:15:00.000Z",
10        "updatedAt": "2026-07-13T13:05:00.000Z",
11        "eTag": "WxYzAbCdEfGhIj"
12    }
13}

Other examples

Combine patch operations, and guard the write with ifMatchesETag

A single updateEntity call can mix add, replace, remove, move, copy, and test in one PNDataSyncPatch. All operations in the call apply together or not at all. Add ifMatchesETag (the ETag from a prior read) to reject the patch with a 412 if the entity changed since you read it, instead of silently overwriting a concurrent change.

1

Remove entity

Deletes an entity by entityId.

Method(s)

1$pubnub->dataSync()->deleteEntity()
2    ->entityId(string)
3    ->ifMatchesETag(string)
4    ->sync(); // PNDataSyncDeleteResult

* required

Parameter	Description
entityId * Type: string Default: n/a	Entity identifier.
ifMatchesETag Type: string Default: n/a	The ETag from a prior read. The delete succeeds only if it still matches, otherwise the server returns 412.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200
3}

Relationships

A relationship links two entities and carries its own payload. In the running example, the ProductOwner relationship links seller-bob to product-sneaker-42.

Relationships are instances of the relationship classes you define on your keyset. A relationship class declares the cardinality the service enforces (one-to-one, one-to-many, or many-to-many) and, optionally, which entity class each side must belong to. Use Create a new relationship class to declare a class, and Get relationship class by name and version to read it back.

Create relationship

Creates a relationship between two entities. The relationship class's cardinality (one-to-one, one-to-many, or many-to-many) is enforced on create. A relationship that violates its class's cardinality is rejected with a 409.

Method(s)

1$pubnub->dataSync()->createRelationship()
2    ->relationshipId(string)
3    ->entityAId(string)
4    ->entityBId(string)
5    ->relationshipClass(string)
6    ->relationshipClassVersion(int)
7    ->status(string)
8    ->payload(array)
9    ->sync(); // PNDataSyncRelationshipResult

* required

Parameter	Description
relationshipId Type: string Default: server-generated	Relationship identifier. Omit to let the server generate a UUID. Max 255 characters.
entityAId * Type: string Default: n/a	Identifier of the first linked entity. Immutable after creation.
entityBId * Type: string Default: n/a	Identifier of the second linked entity. Immutable after creation.
relationshipClass * Type: string Default: n/a	Name of the relationship class this instance belongs to. Set at creation and immutable afterward.
relationshipClassVersion * Type: int Default: n/a	Version of the relationship class schema.
status Type: string Default: n/a	Free-form lifecycle status. Max 100 characters.
payload Type: array Default: n/a	Free-form JSON object holding your application data.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 201,
3    "data": {
4        "id": "rel-bob-owns-sneaker-42",
5        "entityAId": "seller-bob",
6        "entityBId": "product-sneaker-42",
7        "relationshipClass": "ProductOwner",
8        "relationshipClassVersion": 1,
9        "payload": { "since": "2026-07-13" },
10        "createdAt": "2026-07-13T09:20:00.000Z",
11        "updatedAt": "2026-07-13T09:20:00.000Z",
12        "eTag": "YzAbCdEfGhIjKl"
13    }
14}

Get relationship

Returns a single relationship by relationshipId.

Method(s)

1$pubnub->dataSync()->getRelationship()
2    ->relationshipId(string)
3    ->sync(); // PNDataSyncRelationshipResult

* required

Parameter	Description
relationshipId * Type: string Default: n/a	Relationship identifier.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200,
3    "data": {
4        "id": "rel-bob-owns-sneaker-42",
5        "entityAId": "seller-bob",
6        "entityBId": "product-sneaker-42",
7        "relationshipClass": "ProductOwner",
8        "relationshipClassVersion": 1,
9        "payload": { "since": "2026-07-13" },
10        "createdAt": "2026-07-13T09:20:00.000Z",
11        "updatedAt": "2026-07-13T09:20:00.000Z",
12        "eTag": "YzAbCdEfGhIjKl"
13    }
14}

Get all relationships

Returns a paginated list of relationships within a class. The relationshipClass parameter is required. Filter by entityAId or entityBId to list a specific entity's links. For pagination, filtering, and sorting, refer to sorting and pagination.

Method(s)

1$pubnub->dataSync()->getRelationships()
2    ->relationshipClass(string)
3    ->relationshipClassVersion(int)
4    ->entityAId(string)
5    ->entityBId(string)
6    ->cursor(string)
7    ->limit(int)
8    ->filterFast(string)
9    ->filter(string)
10    ->sort(string|array)
11    ->sync(); // PNDataSyncRelationshipsResult

* required

Parameter	Description
relationshipClass * Type: string Default: n/a	Name of the relationship class to list.
relationshipClassVersion Type: int Default: all versions	Relationship class version to list. Omit to list relationships across every version of the class.
entityAId Type: string Default: n/a	List only relationships whose first entity is this id.
entityBId Type: string Default: n/a	List only relationships whose second entity is this id.
cursor Type: string Default: n/a	Opaque pagination cursor. Omit for the first page.
limit Type: int Default: 20	Maximum number of relationships per page. Max 100.
filterFast Type: string Default: n/a	Filter expression evaluated against strongly consistent storage, so it reflects the latest writes. Accepts up to 10 conditions by default (raisable per keyset), over properties declared with filtering mode simple or full. Cannot be combined with filter.
filter Type: string Default: n/a	Filter expression evaluated against eventually consistent storage, so results can briefly lag writes. Supports the full expression language, over properties declared with filtering mode full. Cannot be combined with filterFast.
sort Type: string | array Default: n/a	Order results. Pass a string of fields each optionally suffixed with :asc or :desc, or an array that the SDK joins into one.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200,
3    "data": [
4        {
5            "id": "rel-bob-owns-sneaker-42",
6            "entityAId": "seller-bob",
7            "entityBId": "product-sneaker-42",
8            "relationshipClass": "ProductOwner",
9            "relationshipClassVersion": 1,
10            "payload": { "since": "2026-07-13" },
11            "createdAt": "2026-07-13T09:20:00.000Z",
12            "updatedAt": "2026-07-13T09:20:00.000Z",
13            "eTag": "YzAbCdEfGhIjKl"
14        }
15    ],
16    "meta": {
17        "next_cursor": null,
18        "has_next": false,
19        "limit": 20
20    }
21}

show all 21 lines

Other examples

List an entity's incoming links with entityBId

Pass entityBId instead of entityAId to list relationships where the entity is on the second side of the link.

1

Filter with filterFast

filterFast is evaluated against strongly consistent storage, so it matches an object you just wrote. It runs over properties declared with filtering mode simple or full and accepts up to 10 conditions by default (raisable per keyset). Reference a declared property by its name, not its path. It shares the same expression language as filter, so only one of the two can be sent per call.

1

Filter with filter

filter runs over properties declared with filtering mode full and is evaluated against eventually consistent storage, so a very recent write may not be matched yet. Reference a declared property by its name, not its path. It shares the same expression language as filterFast, so only one of the two can be sent per call.

1

Page through results with cursor

Pass no cursor on the first call. Take getPage()->getNextCursor() from the result and pass it back as cursor on the next call. Stop when getPage()->hasNext() is false.

1

Set relationship

Replaces a relationship in full (PUT). Send the complete set of fields, any field you omit is cleared. relationshipClass is immutable after creation and cannot be sent, and the linked entity ids are immutable too, so setRelationship doesn't expose entityAId/entityBId at all, there's nothing to resend. Refer to optimistic concurrency with ETags for ifMatchesETag. For a partial update, use Update relationship.

Method(s)

1$pubnub->dataSync()->setRelationship()
2    ->relationshipId(string)
3    ->relationshipClassVersion(int)
4    ->status(string)
5    ->payload(array)
6    ->ifMatchesETag(string)
7    ->sync(); // PNDataSyncRelationshipResult

* required

Parameter	Description
relationshipId * Type: string Default: n/a	Relationship identifier.
relationshipClassVersion * Type: int Default: n/a	Version of the relationship class schema.
status Type: string Default: n/a	Free-form lifecycle status. Max 100 characters.
payload Type: array Default: n/a	Free-form JSON object holding your application data.
ifMatchesETag Type: string Default: n/a	The ETag from a prior read. The update succeeds only if it still matches, otherwise the server returns 412.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200,
3    "data": {
4        "id": "rel-bob-owns-sneaker-42",
5        "entityAId": "seller-bob",
6        "entityBId": "product-sneaker-42",
7        "relationshipClass": "ProductOwner",
8        "relationshipClassVersion": 1,
9        "payload": { "since": "2026-07-13", "tier": "gold" },
10        "createdAt": "2026-07-13T09:20:00.000Z",
11        "updatedAt": "2026-07-13T14:00:00.000Z",
12        "eTag": "AbCdEfGhIjKlMn"
13    }
14}

Update relationship

Applies a partial update to a relationship with raw JSON Patch operations. Refer to partial update for the operation model.

Method(s)

1$pubnub->dataSync()->updateRelationship()
2    ->relationshipId(string)
3    ->patch(PNDataSyncPatch|array)
4    ->ifMatchesETag(string)
5    ->sync(); // PNDataSyncRelationshipResult

* required

Parameter	Description
relationshipId * Type: string Default: n/a	Relationship identifier.
patch * Type: PNDataSyncPatch | array Default: n/a	One or more JSON Patch operations. Must contain at least one item. Pass a PNDataSyncPatch builder or a raw array of RFC 6902 operations.
ifMatchesETag Type: string Default: n/a	The ETag from a prior read. The patch succeeds only if it still matches, otherwise the server returns 412.

Use a JSON Pointer that starts with /payload/ to target payload fields, or a root pointer (for example /status) to target a top-level field.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200,
3    "data": {
4        "id": "rel-bob-owns-sneaker-42",
5        "entityAId": "seller-bob",
6        "entityBId": "product-sneaker-42",
7        "relationshipClass": "ProductOwner",
8        "relationshipClassVersion": 1,
9        "payload": { "since": "2026-07-13", "tier": "platinum" },
10        "createdAt": "2026-07-13T09:20:00.000Z",
11        "updatedAt": "2026-07-13T14:05:00.000Z",
12        "eTag": "CdEfGhIjKlMnOp"
13    }
14}

Remove relationship

Deletes a relationship by relationshipId.

Method(s)

1$pubnub->dataSync()->deleteRelationship()
2    ->relationshipId(string)
3    ->ifMatchesETag(string)
4    ->sync(); // PNDataSyncDeleteResult

* required

Parameter	Description
relationshipId * Type: string Default: n/a	Relationship identifier.
ifMatchesETag Type: string Default: n/a	The ETag from a prior read. The delete succeeds only if it still matches, otherwise the server returns 412.

Sample code

Reference code

This example is a self-contained code snippet ready to be run. It includes necessary imports and executes methods with console logging. Use it as a reference when working with other examples in this document.

1

Response

1{
2    "status": 200
3}

Real-time updates

DataSync objects can publish create, update, and delete events that you receive in real time by subclassing SubscribeCallback and overriding dataSyncEvent. Attach the listener to the PubNub client with addListener, then subscribe to the object's data channel with subscribe()->channels(...)->execute(), as described in Add DataSync listener.

1

Each event names the change in getEvent(), identifies the object kind in getType() (user, channel, membership, entity, or relationship), and carries the object state in getEntity(), getRelationship(), or getMembership(). For a delete event, getId() and getDeletedAt() carry the identifier and the deletion timestamp, and the three state getters return null.

getType() names the object kind directly, while create and update events populate one of the typed getters:

Change to	getType()	State arrives in
A user	user	getEntity()
A channel	channel	getEntity()
An entity	entity	getEntity()
A membership	membership	getMembership() and getRelationship()
A relationship	relationship	getRelationship()

Dispatch on getType() rather than on which getter returns a record, because getEntity() is shared by three kinds. getClassName() tells you the specific class within a kind, for example which subclass of User an event belongs to.

Where each event is delivered

The channels that receive an event depend on the changed object. A relationship or membership never publishes on a channel named after its own id:

Change to	On create	On update or delete
A user	The user's getId()	The user's getId(), plus the getId() of every entity, user, or channel connected to it by a relationship or membership
A channel	The channel's getId()	The channel's getId(), plus the getId() of every entity, user, or channel connected to it by a relationship or membership
An entity	The entity's getId()	The entity's getId(), plus the getId() of every entity, user, or channel connected to it by a relationship or membership
A membership	Both the getUserId() and the getChannelId() of the membership	Same as create
A relationship	Both the getEntityAId() and the getEntityBId() of the relationship	Same as create

Update and delete also fan out to connected objects

An update or delete on a user, channel, or entity is also delivered on the getId() channel of every other object connected to it by a relationship or membership, in either direction, at the time of the change. A client subscribed to a connected object's channel receives the event too, even though that object itself did not change. A create does not fan out this way, because nothing can be connected to a brand new object yet.

The connected channels are entity, user, and channel ids. Relationships and memberships never get an id channel of their own, so they never appear in this fan-out as a channel name.

So to see memberships appear and disappear for Alice, subscribe to user-alice rather than the membership id. A client subscribed to both sides of the same link receives the change twice, once per channel. Deduplicate create and update events on the object's getId() and getUpdatedAt(), and delete events on getId() and getDeletedAt().

For a membership event, getRelationship()->getEntityAId() is the channel id and getRelationship()->getEntityBId() is the user id. The service sends these as channelId and userId, and the SDK maps them onto the A and B sides so that one result type serves both memberships and your own relationships. getMembership() returns the same record under its own names.

Projection channels

Each projection declared on the class gets its own event, published to its own channel, and carrying only that projection's view of the payload:

Projection	Channel	Payload
__default__ (the base projection)	The object's own id, for example product-sneaker-42	The fields tagged __default__
Any named projection, for example admin	__<projection>__<id>, for example __admin__product-sneaker-42	The fields tagged with that projection

A projection name must start with a letter or digit, so a leading __ marks a projection channel, with __default__ as the only exception.

Avoid ids that start with two underscores

A projection channel is named __<projection>__<id>, so an object id in that form can collide with another object's projection channel. The service doesn't reject such ids today, so avoid any id that starts with __.

Filtering applies to getPayload() and to getStatus(): each is included in a given projection's event only if the class declares it under that projection, falling back to __default__ when the class never declares status. getId(), getETag(), getCreatedAt(), getUpdatedAt(), and getExpiresAt() are never filtered. Every projection's event carries them unchanged.

So one change to an object whose class declares an admin projection publishes two events, and a client subscribed only to product-sneaker-42 never sees the admin-only fields:

1

If the class declares no properties at all there is nothing to filter, so a single unfiltered event is published to the object's own id channel.

Projection channels need channel grants

Publishing to __<projection>__<id> is an ordinary channel publish, and it isn't gated by the dataSyncProjections entries in a token. Use Access Manager addChannelResources grants to control who can subscribe to a projection channel. Anyone who can subscribe there receives the restricted fields. Refer to Grant token.

Delete events are never filtered by a projection.

Events are off by default and are enabled per class in the Admin Portal. Refer to enabling events for how to turn them on, and receiving events for the listener flow.