Get Storage By User Id

sedmonds · September 10, 2024, 6:28pm

In the Nakama console, you can filter/search Storage collections by User Id but there doesnt appear to be a way to do this at runtime using any of the existing API endpoints/RPCs?

Looking at the console source, I see that the console uses SQL to achieve this filtering:

github.com

heroiclabs/nakama/blob/12abcf8ada8186418b62a3893f002a3415ed0340/server/console_storage.go#L215


      
          		if cursor != nil {
          			params = append(params, cursor.Collection, cursor.Read, cursor.Key, cursor.UserID)
          			query += " WHERE (collection, read, key, user_id) > ($1, $2, $3, $4)"
          		}
          		params = append(params, limit+1)
          		query += " ORDER BY collection ASC, read ASC, key ASC, user_id ASC LIMIT $" + strconv.Itoa(len(params))
          	case in.Collection == "" && in.Key == "" && userID != nil:
          		// Filtering by user ID only returns all results, no pagination or limit.
          		limit = 0
          		params = []interface{}{*userID}
          		query = "SELECT collection, key, user_id, version, read, write, create_time, update_time FROM storage WHERE user_id = $1"
          	case in.Collection != "" && in.Key == "" && userID == nil:
          		// Collection only. Querying and paginating on primary key (collection, read, key, user_id).
          		params = []interface{}{in.Collection}
          		query = "SELECT collection, key, user_id, version, read, write, create_time, update_time FROM storage WHERE collection = $1"
          		if cursor != nil {
          			params = append(params, cursor.Read, cursor.Key, cursor.UserID)
          			query += " AND (collection, read, key, user_id) > ($1, $2, $3, $4)"
          		}
          		params = append(params, limit+1)
          		query += " ORDER BY read ASC, key ASC, user_id ASC LIMIT $" + strconv.Itoa(len(params))

I know that using direct SQL in custom RPC functions is discouraged in many cases, but is this going to be our only way of achieving the end result in this case?

TIA!

sesposito · September 12, 2024, 2:07pm

Hello @sedmonds,

Fetching all storage objects per user is not ideal since an account may have many objects. The Storage Engine is not optimized for this use case and may perform poorly at scale. An exception is made in the Console as the query is expected to be executed seldom as opposite to the runtime and client-facing APIs.

Ideally you should know which objects you need by user, collection and key and load them when appropriate, or use the storageList API to traverse a collection.

Best.

Topic		Replies	Views
How to read all objects from postgres storage in Nakama Go lang Runtime Framework golang	3	286	October 6, 2023
Storage Engine Object Privacy Local Setup getting-started	10	1668	January 16, 2020
How to write/load Global Storage Objects from Client without User Id Local Setup sdk-unity	4	1178	December 8, 2020
What userId to use for a Global storageRead from a TS RPC? Runtime Framework typescript	2	475	July 14, 2022
Find storage object by value Runtime Framework	2	265	April 4, 2023

Get Storage By User Id

Related Topics