Database

Spotify local sync: searchable entities, .search() filters, and operators.

The Spotify plugin syncs data locally. Use corsair.spotify.db.<entity>.search({ data, limit?, offset? }) with the filters listed per entity.

New to Corsair? See database operations, data synchronization, and multi-tenancy.

Albums

Path: spotify.db.albums.search

const rows = await corsair.spotify.db.albums.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
entity_id	string	equals, contains, startsWith, endsWith, in
id	string	equals, contains, startsWith, endsWith, in
name	string	equals, contains, startsWith, endsWith, in
album_type	string	equals, contains, startsWith, endsWith, in
total_tracks	number	equals, gt, gte, lt, lte, in
href	string	equals, contains, startsWith, endsWith, in
release_date	string	equals, contains, startsWith, endsWith, in
release_date_precision	string	equals, contains, startsWith, endsWith, in
createdAt	date	equals, before, after, between

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

---

Artists

Path: spotify.db.artists.search

const rows = await corsair.spotify.db.artists.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
entity_id	string	equals, contains, startsWith, endsWith, in
id	string	equals, contains, startsWith, endsWith, in
name	string	equals, contains, startsWith, endsWith, in
href	string	equals, contains, startsWith, endsWith, in
popularity	number	equals, gt, gte, lt, lte, in
createdAt	date	equals, before, after, between

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

---

Playlist Items

Path: spotify.db.playlistItems.search

const rows = await corsair.spotify.db.playlistItems.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
entity_id	string	equals, contains, startsWith, endsWith, in
id	string	equals, contains, startsWith, endsWith, in
playlist_id	string	equals, contains, startsWith, endsWith, in
track_id	string	equals, contains, startsWith, endsWith, in
added_at	string	equals, contains, startsWith, endsWith, in
is_local	boolean	equals
position	number	equals, gt, gte, lt, lte, in
createdAt	date	equals, before, after, between

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

---

Playlists

Path: spotify.db.playlists.search

const rows = await corsair.spotify.db.playlists.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
entity_id	string	equals, contains, startsWith, endsWith, in
id	string	equals, contains, startsWith, endsWith, in
name	string	equals, contains, startsWith, endsWith, in
description	string	equals, contains, startsWith, endsWith, in
public	boolean	equals
collaborative	boolean	equals
href	string	equals, contains, startsWith, endsWith, in
createdAt	date	equals, before, after, between

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

---

Tracks

Path: spotify.db.tracks.search

const rows = await corsair.spotify.db.tracks.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
entity_id	string	equals, contains, startsWith, endsWith, in
id	string	equals, contains, startsWith, endsWith, in
name	string	equals, contains, startsWith, endsWith, in
duration_ms	number	equals, gt, gte, lt, lte, in
explicit	boolean	equals
href	string	equals, contains, startsWith, endsWith, in
is_local	boolean	equals
popularity	number	equals, gt, gte, lt, lte, in
preview_url	string	equals, contains, startsWith, endsWith, in
track_number	number	equals, gt, gte, lt, lte, in
createdAt	date	equals, before, after, between

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

---

Users

Path: spotify.db.users.search

const rows = await corsair.spotify.db.users.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

Searchable filters

Field	Type	Operators
entity_id	string	equals, contains, startsWith, endsWith, in
id	string	equals, contains, startsWith, endsWith, in
display_name	string	equals, contains, startsWith, endsWith, in
href	string	equals, contains, startsWith, endsWith, in
product	string	equals, contains, startsWith, endsWith, in
type	string	equals, contains, startsWith, endsWith, in
uri	string	equals, contains, startsWith, endsWith, in
createdAt	date	equals, before, after, between

Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

---