See on GitHub

    Creating Sample Data

    • Sample data can be created in playground databases to enable developers to experiment with features before making changes to their actual database.
      It is populated with various collections, .json documents, indexes, and document extensions.

    • Many of the examples in the RavenDB documentation are based on this sample data.
      Creating it will enable you to play with the data as you use the documentation to familiarize yourself with RavenDB features.

    • In this page:

    Create Sample Data

    • Sample data can be added only on an empty database.

    • To create sample data, you can either empty your playground database or create a new database.

    • If you plan to use multiple nodes and/or encryption in production, we recommend installing your playground database in a similar environment.

    Figure 1. Create Sample Data

    Create Sample Data

    To create Sample Data:

    1. Tasks tab
      Click to see task options.
    2. Create Sample Data
      Select to access the Sample Data screen.
    3. Create
      Click the Create button to generate the Northwind sample data.
      Various collections, their documents and sample indexes will be created in your database.

    The Data Generated - Documents View

    Figure 2. Documents View

    Documents View

    1. Documents tab
      Click to open documents options.
    2. Document Collections
      This is the first part of the auto-generated document Id string.
      • In code, the Id string is all lowercase (e.g. employees/5-A).
    3. Document Ids
      Unique document identification keys.
    4. Collection
      Which collection each document is in.
    5. Document Extensions
      This column shows which types of document extensions are included in each document.

    The Indexes Generated - Indexes View

    Figure 3. Indexes View

    Indexes View

    1. Index tab
      Click to view and modify current indexes.
    2. List of Indexes
      Select to see the list of current indexes.
    3. Query this index.
      A general query automatically determines the best index to query and creates new ones if a good index doesn't exist for that query.
      Still, you can query specific indexes via the List of Indexes.
    4. Edit this index.
      Indexes can be modified via Studio.
      Read Modifying Index Definition to learn more.

    The C# Entities

    The C# classes used for Sample Data document entities can also be viewed.

    Figure 4. The C# classes

    C# Classes

    1. Select Tasks tab -> Create Sample Data.
    2. Click to View C# classes.
    3. Sample data C# code
      C# classes.
      Scroll in C# code section to see more.

    Home / Docs / Studio / Database / Tasks / Create Sample Data