Intro
AppDB stores JSON documents in Domo like a NoSQL database. You can store data in collections, update documents, update collection schema, add document-level filters, and manage permissions. You can also perform all of these tasks through API calls. For information on using APIs with AppDB, see AppDB API in our developer documentation.This article describes how to access and manage AppDB collections in the following topics:
Access AppDB Admin
-
In the navigation header, select
More > Asset Library.
-
In the left navigation, select
AppDB Admin.
Searching and Filters
To find a specific collection, enter a keyword in the search bar. You can select
Add Filters to apply other Filters and narrow down the list of search results.
Remove a Filter by selecting ✖ for that Filter.
Create a Collection
-
On the
AppDB Admin landing page, select Create a Collection.
You are prompted to enter a Collection Name and an optional Datastore Name.
Note: If you add a datastore name when creating a collection, a datastore is created in Domo for that collection. This can be helpful because it creates other possible keywords to search for if you remember the datastore name but not the collection name. The datastore name displays in the App Name column of your collection.
- Select Create. The collection details page displays.
Collection Details
The collection Details page has three tabs: Data Explorer, Configuration, and Permissions. The Data Explorer tab is open by default. This section describes the actions you can perform within each tab.Data Explorer
The Data Explorer allows you to create, modify, and query documents in a collection, all of which are described below.Create a Document
-
Select
+ New Document.
The New Document modal displays.
- Specify the content of your new document in a JSON format.
Note:
If the collection schema has been defined, the modal prepopulates the default value.
- Select Create.
Modify a Document
-
Select the three-dot menu next to the document.
The document options display.
-
Select one of the following document options:
- Edit — Allows you to modify the document’s content.
- Copy — Duplicates the document.
- Sync — Displays the most recent version of the document.
- Delete — Deletes the document.
Querying and Filters
- To query on a certain item in the data, go to the Filters section in Data Explorer and select + Add New. A blank Filter displays.
- Select a field to filter on from the Select Field list.
- Select a logical operator.
- Enter the query term.
-
Select
Apply.
Delete next to the Filter fields.
Sort Results with Aggregations
You can sort the results of your Filter using aggregations, as described below.- In the Query Builder under Aggregations, select + Add New. The aggregation fields display.
- Select the aggregation method.
- Select the Field to sort by.
-
Select the order.
- Select Apply to sort the results by your aggregation.
Delete next to the aggregation fields.
Note:
Some aggregations, like
average
and
groupby
, support multiple columns.
Configuration
The Configuration tab displays all currently defined columns and allows you to add and modify columns.Add a Column
-
Select
+ Add Column.
A record is added at the bottom of the Schema Builder.
- Enter a Column Name.
-
Select a
Column Type from the list.
Modify a Column
You can modify a column by editing its name or column type, reordering it, or deleting it, as described below.-
Edit Name —
Hover over the name of the column until the pencil appears, then select it and enter the new column name.
-
Edit Column Type —
Select the
arrow to show the list and select the new column type.
-
Reorder Columns —
Hover over the
Reorder Handle until the cursor becomes a hand, then drag the column record to the correct location.
-
Delete Columns —
Hover over the column until
Delete displays and select Delete.
Permissions
The Permissions tab is where you manage your collection’s sharing permissions. Use Document Security Filters to create specific queries that restrict users to viewing or using only certain data that is stored in the collection. These Filters are like Personalized Data Permissions (PDP) for AppDB.Share Collection Access
At the top of the Permissions tab, you can see a list of users who have access to the collection.-
To add or modify access, select
.
The Share Access for Collection modal displays.
- Enter a person or group in the search bar to find their profile.
-
Next to the person’s name, select the access list to choose what level of access that user should have. The options are as follows:
- Read
- Write
- Delete
- Share
- Admin
- Read Content
- Create Content
- Update Content
- Delete Content
- No Access
- Select Save.
Connect an App
To connect your collection to an app, follow these steps:-
Select
+ Share With New App.
The Manage Permissions modal displays.
- Enter the name of an app in the search bar or scroll to find it.
-
Next to the app’s name, select the access list to choose what level of access that app should have. The options are as follows:
- Read
- Write
- Delete
- Share
- Admin
- Read Content
- Create Content
- Update Content
- Delete Content
- No Access
- Select Save.
Add a Permission
- Select + Add Permissions. A blank permission record displays.
- Enter a Filter Name.
- In the Add groups & people modal that displays, select Apply To and add groups and people that the Filter should apply to. Alternatively, you can select Apply To and select the Apply to All checkbox.
-
Select
Apply Changes.
The modal closes with the saved changes
-
Under
Query, select the Limit To Owner checkbox or select Modify Query to modify the JSON request.
- In the Apply On list, select the action to apply the permission to. The options are Read, Update, and Delete.
- Select Save.
Delete to delete a Filter.
Export a Collection
On each Collection Details tab, the Export Collection option displays near the top of the screen. Select Export Collection to download the current collection as a JSON file.