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 ConfigureServices method of the Startup.cs file:

public void ConfigureServices(IServiceCollection services)
{
	// other configurations
	services.ConfigureFlexmonsterOptions(Configuration);
	// other configurations
}

To configure the Data Server through code, you can use the ConfigureServices method of the Startup.cs class. See how to:

• Create indexes
• Set data storage options

Create indexes

Step 1. Open the Startup.cs file and find the ConfigureServices method.

Step 2. In ConfigureServices, call the services.Configure<DatasourceOptions> method:

public void ConfigureServices(IServiceCollection services)
{
	// other configurations
	services.Configure<DatasourceOptions>((options) => {
	});
	// other configurations
}

Step 3. Inside of services.Configure<DatasourceOptions>, create a dictionary to store your indexes:

public void ConfigureServices(IServiceCollection services)
{
	// other configurations
	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 4. Add your index to the Indexes dictionary. For example, let’s create a new JSON index:

public void ConfigureServices(IServiceCollection services)
{
	// other configurations
	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. See a list of these classes and their constructors:

• 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. Open the Startup.cs file and find the ConfigureServices method.

Step 2. In ConfigureServices, call the services.Configure<DataStorageOptions> method:

public void ConfigureServices(IServiceCollection services)
{
	// other configurations
	services.Configure<DataStorageOptions>((options) => {
	});
	// other configurations
}

Step 3. Set the needed data storage options through the options object:

public void ConfigureServices(IServiceCollection services)
{
	// other configurations
	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. It can be done by importing configs from appsettings.json before adding configs through code:

public void ConfigureServices(IServiceCollection services)
{
	// other configurations
	services.ConfigureFlexmonsterOptions(Configuration);

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