Add, query, and mutate data using NerdStorage

NerdStorage is a document database accessible within New Relic. It allows you to modify, save, and retrieve documents from one session to the next.

Using NerdStorage, you can create individual documents of up to 64kb in size, create different collections of documents, and store data by entity, account, or user level.

This guide explains how to add data and documents to NerdStorage. For an introduction to what NerdStorage is and how it works, see Intro to NerdStorage.

Before you begin

This guide requires that you have an API key and the New Relic One CLI as described in Set up your development environment.

Get started

First, get the NerdStorage app running successfully inside New Relic.

Step 1 of 3

Clone the example applications from the GitHub repo.

Step 2 of 3

Use the New Relic One CLI to update the application UUID and run the application locally.

In the terminal, switch to the /nr1-how-to/use-nerdstorage directory:

bash

$cd /nr1-how-to/use-nerdstorage

Update the UUID and serve the application:

bash

$nr1 update
$nr1 nerdpack:uuid -gf
$nr1 nerdpack:serve

Step 3 of 3

Once the app is successfully served, your terminal will return the URL to view your running application on New Relic.

Load the URL. Click Apps and under Your apps you'll see the Use Nerdstorage app listed. Click to launch the app.

Your applications view updated

Add data to NerdStorage

Once the app is up and running on New Relic, you can prepare the app and start adding data.

On the How To Use NerdStorage app screen, there's a Saved to NerdStorage pane with a field for adding data. However, if you type something you'll get an error message. This is because you need to be set up to store data at the User level. You can do this with the help of the UserStorageMutation component.

add data view 1

Step 1 of 3

Open the application’s ./nerdlets/use-nerdstorage-nerdlet/index.js file in the text editor of your choice and find the code for the TextField and Button used to enter data. The Button onClick prop makes a call to a helper method called _addToNerdStorage, and you need to update it to add UserStorageMutation

The UserStorage NerdStorage components require a collection and documentId. In the constructor method in the application’s index.js file, you can see the variables being provided. In the .js file, it will look something like this:

constructor(props) {
    super(props)
    this.collectionId = 'mycollection';
    this.documentId = 'learning-nerdstorage';
    this.state = {
        isOpen: true,
        storage: [],
        text: '',
    };
    this._addToNerdStorage = this._addToNerdStorage.bind(this);
    this._removeFromNerdStorage = this._removeFromNerdStorage.bind(this);
    this._deleteDocument = this._deleteDocument.bind(this);
}

Step 2 of 3

Import the UserStorageMutation by adding it to your import statement at the top of the index.js file:

import { UserStorageMutation } from 'nr1';

Then update the helper with this code beginning with _addToNerdStorage:

_addToNerdStorage(){
    const { text, storage } = this.state;
    storage.push(text);
    this.setState({storage}, () => {
        UserStorageMutation.mutate({
            actionType: UserStorageMutation.ACTION_TYPE.WRITE_DOCUMENT,
            collection: this.collectionId,
            documentId: this.documentId,
            document: { storage },
        })
        .then((res) => {
            this.setState({text: ''});
            Toast.showToast({ title: "NerdStorage Update.", type: Toast.TYPE.NORMAL });
        })
        .catch((err) => console.log(err));
    });
}

Step 3 of 3

Return to your running How To Use NerdStorage app screen in New Relic and reload the page.
Add some text in the text entry field and click the check button. This will update NerdStorage and trigger a Toast notification inside the app. You should then see the text you typed displayed as a table row below the text entry field.

add data view 2

Query data from NerdStorage

Once you get data storage working as described in the section above, you also need to get the app properly reading data from NerdStorage, or the app will reload with an empty state every time you navigate away from the app page and back. To do this, add the UserStorageQuery component and update the componentDidMount method.

Step 1 of 3

Import the UserStorageQuery by adding it to the import statement in the application’s ./nerdlets/use-nerdstorage-nerdlet/index.js file.

import { UserStorageMutation, UserStorageQuery } from 'nr1';

Step 2 of 3

Then, add the following componentDidMount method to your application:

componentDidMount(){
    UserStorageQuery.query({
        collection: this.collectionId,
        documentId: this.documentId,
    })
    .then(({ data }) => {
        if(data !== null) {
            this.setState({storage: data.storage});
        }
    })
    .catch(err => console.log(err));
}

Step 3 of 3

Back inside the NerdStorage app, test your changes by adding a few more rows using the text entry field. Then exit and relaunch the application. The application should load and show all the data you entered before you navigated away.

Mutate data in NerdStorage

Each NerdStorage entry displayed in the table inside the app has a trash button that can be used to update a specific entry. The trash button works by making a call to the _removeFromNerdStorage helper method.

Step 1 of 1

To get this process working, update the code in _removeFromNerdStorage:

_removeFromNerdStorage(index, data){
    const { storage } = this.state;
    storage.pop(data);

    this.setState({storage}, () => {
        UserStorageMutation.mutate({
            actionType: UserStorageMutation.ACTION_TYPE.WRITE_DOCUMENT,
            collection: this.collectionId,
            documentId: this.documentId,
            document: { storage },
        })
        .then((res) => {
            Toast.showToast({ title: "NerdStorage Update.", type: Toast.TYPE.NORMAL });
        })
        .catch((err) => console.log(err));
    });
}

Once you do this, clicking the trash button removes the item it's associated with, and the app updates to show the change.

mutate data

Delete collection from NerdStorage

While the trash button is a good method for removing specific entries one at a time, you may also want the ability to delete a whole NerdStorage document at once. You can do this by adding the Delete Document button to your app.

Step 1 of 2

Add a new GridItem to the application immediately before the closing Grid tag. In the new GridItem add the following code to display your new button:

<Button
  onClick={() => this._deleteDocument()}
  type={Button.TYPE.DESTRUCTIVE}
  sizeType={Button.SIZE_TYPE.SMALL}
  iconType={Button.ICON_TYPE.INTERFACE__OPERATIONS__TRASH}
>
  Delete Document
</Button>;

Step 2 of 2

Because the new Delete Document button will be calling the _deleteDocument helper method, you'll need to update that using this code:

_deleteDocument(){
    this.setState({storage: []});
    UserStorageMutation.mutate({
        actionType: UserStorageMutation.ACTION_TYPE.DELETE_DOCUMENT,
        collection: this.collectionId,
        documentId: this.documentId,
    });
    Toast.showToast({ title: "NerdStorage Update.", type: Toast.TYPE.CRITICAL });
}

Back inside the application, you should now see both the individual trash buttons and the newly added Delete Document button.

delete collection button view

Next steps

Now that you’ve successfully implemented NerdStorage into a New Relic application, you can store and mutate data connected to your User. For more information on the various NerdStorage components, please visit the New Relic developer website API documentation.