Configurations reference

Flexmonster.DataServer.Core.dll can be configured via the ASP.NET configuration file (e.g., appsettings.json). In addition to the Data Server's configuration, this file can contain any other settings needed for the project, as long as they do not conflict with each other.

To configure the Data Server via appsettings.json, follow the steps below:

Step 1. Define the needed configurations in appsettings.json. Here is an example of a configured appsettings.json file with the custom parser:

{
  "DataSources": [
    {
      "Type": "custom-parser",
      "Indexes": {
        "custom-index": null
      }
    },
    {
      "Type": "json",
      "Indexes": {
        "first-json-index": {
          "Path": "data/data.json" 
        },
        "second-json-index": {
          "Path": "data/another-data.json"
        }
      }
    },
    {
      "Type": "csv",
      "Indexes": {
        "csv-index": {
          "Path": "data/data.csv",
          "Delimiter": ";",
          "DecimalSeparator": "."
        }
      }
    }
  ],
  "DataStorageOptions": {
    "DataRefreshTime": 60,
    "CacheSizeLimit": 150
  }
}

Step 2. To apply configs from appsettings.json, add the following line of code to the Program.cs file:

using Flexmonster.DataServer.Core;

var builder = WebApplication.CreateBuilder(args);
builder.Services.ConfigureFlexmonsterOptions(builder.Configuration);
// Other configurations

You can configure the Data Server through code using the Program.cs file. See how to:

• Create indexes
• Set data storage options

Create indexes

Step 1. In the Program.cs file, call the builder.Services.Configure<DatasourceOptions>() method:

var builder = WebApplication.CreateBuilder(args);
// Other configurations

builder.Services.Configure<DatasourceOptions>((options) => {
});
// Other configurations

Step 2. In builder.Services.Configure<DatasourceOptions>(), create a dictionary to store your indexes:

// Other configurations

builder.Services.Configure<DatasourceOptions>((options) => {
    options.Indexes = new Dictionary<string, IndexOptions>();
});
// Other configurations

As you can see, each index consists of two fields:

• A string field, which is the index’s name.
• An IndexOptions field, which contains configurations needed to load the index’s data. IndexOptions is an abstract class.

Step 3. Add your index to the Indexes dictionary. For example, let’s create a new JSON index:

// Other configurations

builder.Services.Configure<DatasourceOptions>((options) => {
    options.Indexes = new Dictionary<string, IndexOptions>();
    options.Indexes.Add("json-index", 
      new JsonIndexOptions("path-to-your-file.json"));
});
// Other configurations

JsonIndexOptions is a class that allows configuring JSON indexes. It is based on the IndexOptions class.

CSV and database indexes are configured through similar classes:

• JSON:
  • public JsonIndexOptions(string path)
• CSV:
  • public CsvIndexOptions(string path)
  • public CsvIndexOptions(string path, char delimiter, char decimalSeparator, char thousandsSeparator)
• Databases:
  • public DatabaseIndexOptions(databaseType, connectionString, query)

See the full list of configurations for indexes.

Set data storage options

Step 1. In the Program.cs file, add the following lines of code:

using Flexmonster.DataServer.Core.DataStorages;

var builder = WebApplication.CreateBuilder(args);
// Other configurations

builder.Services.Configure<DataStorageOptions>((options) => {
});
// Other configurations

Step 2. Set the needed data storage options using the options object:

// Other configurations

builder.Services.Configure<DataStorageOptions>((options) =>
{
    options.CacheSizeLimit = 100;
    options.DataRefreshTime = 60;
});
// Other configurations

See the full list of available data storage options.

If needed, you can load configs from appsettings.json and then continue configuring the Data Server through code:

using Flexmonster.DataServer.Core;

var builder = WebApplication.CreateBuilder(args);
// Apply configs from appsettings.json:
builder.Services.ConfigureFlexmonsterOptions(builder.Configuration);

/* Note: importing configs from the file overrides configs
   set through code. That’s why you should always 
   add your configs after the 
   builder.Services.ConfigureFlexmonsterOptions(builder.Configuration) 
   line
*/
builder.Services.Configure<DatasourceOptions>((options) => {
    options.Indexes = new Dictionary<string, IndexOptions>();
    options.Indexes.Add("json-index", 
      new JsonIndexOptions("path-to-your-file.json"));
});
// Other configurations