Skip to content

Databases Guide

Setting Up Your Stream Database: A Complete Guide

Getting Started

Begin your database setup journey by navigating to the Databases tab on your dashboard, it is in a dropdown underneath the Knowledge tab. Upon arrival, you’ll see the main Databases page, featuring the title, a green “Add New Database” button for creation, and an informative description explaining the feature’s purpose.

Creating Your First Database

When you’re ready to create your first database, locate the green “Add New Database” button at the top of the page. Clicking this will open a configuration panel on the right side of your browser, where you’ll begin shaping your database’s structure and functionality.

Configuration Process

Basic Setup

The first step involves naming your database. This name serves as both an identifier and, by default, the command name that viewers will use to interact with it. Think carefully about this name, as it should reflect the database’s purpose while remaining easy to type and remember.

Description and Purpose

Next, you’ll add a description of your database. While this might seem optional, a clear description helps you remember the database’s purpose, especially as you create multiple databases for different aspects of your stream. Think of it as a note to your future self about why you created this particular database.

Command Configuration

The command name field automatically populates based on your database name, but you can customise it if you prefer something different. Remember that all commands require an exclamation mark (!) prefix. This command becomes the primary way your community interacts with the stored information.

AI Integration

The AI toggle enables intelligent response crafting. When enabled, the system can generate dynamic responses incorporating your database content. This feature adds variety and personality to your database interactions.

Output Formatting

In the output field, you’ll find essential merge fields like {content} and {added_by}. These fields are crucial for displaying information properly. For example, including both fields might show “Quote #12: ‘Never give up!’ (added by Moderator123)”. Think carefully about how you want information presented to your viewers.

Access Controls

Two important permission settings need your attention:

First, decide who can add values to your database using the addition command (typically structured as !databasename add {content}). You might restrict this to moderators for quote databases but allow all viewers to contribute to game suggestion databases.

Second, determine who can retrieve information from the database. This setting controls who can use the basic lookup commands to view the stored content.

Database Management Interface

After saving your configuration, your new database appears in the main list. Here you’ll find several important tools:

Data Viewer

The table icon opens a comprehensive view of your database entries, showing:

  • Unique ID numbers for each entry
  • Content of each entry
  • Who added the information
  • When it was added

Import Functionality

The import feature allows you to bring existing data into your database:

Database Import Interface

This interface accepts both .txt and CSV files through drag-and-drop or file browser selection. This proves invaluable when migrating from other systems or adding bulk data.

Manual Entry and Management

The interface provides several data management options:

  • Add individual entries manually
  • Edit existing content for accuracy
  • Remove specific entries as needed
  • Clear the entire database if required

Configuration Management

The pencil icon allows you to modify your database settings at any time, while the bin icon provides the option to remove the database entirely if it’s no longer needed.

Best Practices

When setting up your database, consider these important points:

  • Double-check your output formatting to ensure it includes all necessary merge fields
  • Test your commands thoroughly before announcing them to your community
  • Document your command structure for moderators and trusted users
  • Regularly review and backup your database content
  • Consider how different permission levels might affect your stream’s dynamics

Remember that databases can evolve with your stream’s needs. Start simple, and expand functionality as you become more comfortable with the system and better understand your community’s needs.

Video Tutorial

For more information on how to create databases, please refer to the Databases Tutorial or watch the video below: