Skip to content

Commit

Permalink
Update documentation for the PostScriptFilePath command parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
YuriyIvon committed Feb 4, 2024
1 parent f2132c5 commit d82e859
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ DatabaseBenchmark create --DatabaseType=MongoDb --ConnectionString="mongodb://lo

Connection string samples for each of the database engines can be found in the [corresponding section](#connection_strings).

There are a few parameters specific to the `create` command:
Other optional parameters of the `create` command are:
* `DropExisting` - specifies whether to re-create the table if it already exists.
* `PostScriptFilePath` - path to a database script to be executed after the table has been created. Can be used to automate index creation when a table is re-created during the benchmark.

Expand Down Expand Up @@ -103,10 +103,11 @@ Here file [SalesSqlServerDataSource.json](https://github.com/YuriyIvon/DatabaseB

More information on all data source types and their parameters can be found in the [corresponding section](#data_sources).

Other optional parameters of the import command are:
Other optional parameters of the `import` command are:
* `MappingFilePath` - in case column names in the data source don't match table columns (like in the example above, where CSV headers contain space characters), this parameter can be used to point to a JSON file with column mappings. An object in this file must have `Columns` array where each item consists of two fields - `SourceColumnName` and `TableColumnName`.
* `DataSourceCulture` - culture identifier (e.g., "en-GB") used for parsing input string values if a string value is mapped to a non-string column. The current system culture is used by default.
* `DataSourceMaxRows` - the maximum number of rows that the data source can return.
* `DataSourceMaxRows` - maximum number of rows that the data source can return.
* `PostScriptFilePath` - path to a database script to be executed after the data has been imported. One of its typical uses is rebuilding indices.

This command also has a database-specific parameter:
* `MongoDb.CollectCosmosDbRequestUnits` - allows collecting request charge metric in case of Azure Cosmos DB API for MongoDB (may affect query timing).
Expand Down

0 comments on commit d82e859

Please sign in to comment.