Database Migration

Runtime Framework
, ,
1

How add database migration,(add new field to existing collection in data base need to take effect every user new and old).
for example - after the game launch in production.
As the part of updation of game i need to add more fields to existing character collection storage - like new “character” to the game.
it need to take effect in all users in databse, new and old too…
how will i do this, please help, i stuck in this for 3 months, Please help

we already created the database objects, also doing data management and crates opening and giving reward from these collections of data.

image
image1821×838 77.9 KB

@novabyte @sesposito @ftkg

2

@Albertcleetus to clarify, you’d like to add new storage objects to all existing accounts?

3

yes , that’s the thing. please help @sesposito

4

@sesposito did you need any code screenshot or our system setup?

5

@Albertcleetus the best way to do this would be player-by-player instead of all the users.
Use an after hook on your authentication method call that checks if the storage objects exist and if not, creates them for the user.

6

you telling every time login a user, check that user had this collection or object in collection, if it’s not, create for it.

7

That’s correct. This means you only need to perform the work of migrating data for active players and is our recommended approach.

8

Can you share any Database migration script example here. please @sesposito

9

Using TS as an example, you’d do something like this:

function InitModule(ctx: nkruntime.Context, logger: nkruntime.Logger, nk: nkruntime.Nakama, initializer: nkruntime.Initializer) {
    initializer.registerAfterAuthenticateEmail(addNewStorageObjectsFn);

    logger.info('JavaScript logic loaded.');
}


function addNewStorageObjectsFn(ctx: nkruntime.Context, logger: nkruntime.Logger, nk: nkruntime.Nakama, data: nkruntime.Session, request: nkruntime.AuthenticateEmailRequest): void  {
    let user = nk.usersGetUsername([request.username]);
    if (user.length != 1) {
        throw Error('User not found');
    }

    try {
        let userId = user[0].userId;

        let objects = nk.storageRead([{
            collection: 'foo',
            key: 'bar',
            userId: userId,
        }]);

        if (objects.length === 0) {
            // Object not found, create it

            let newObject = {
                food: ['apple', 'pear'],
            };     

            nk.storageWrite([{
                collection: 'foo',
                key: 'baz',
                userId: userId,
                value: newObject,
            }]);
        }
    } catch(error) {
        logger.error('Error: %v', error);
    }
}

For further examples pelase check out our project template.

10

@sesposito Thank you so much , I going to integrate and let you know

11

Yes ,its worked my database migration work Completed , its perfect @sesposito