Skip to content

Commit 6fdaa9a

Browse files
authored
Update README.md
1 parent 447bbf5 commit 6fdaa9a

File tree

1 file changed

+2
-5
lines changed

1 file changed

+2
-5
lines changed

README.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,28 +9,25 @@ A second project "[KustoSchemaToolsAction](https://github.com/github/KustoSchema
99
The `database` object holds all schema related information for a Kusto database. It can be loaded from, or written to a cluster using the `KustoDatabaseHandler` which can be created by the `KustoDatabaseHandlerFactory`.There are several steps involved for loading a all relevant information from a kusto database into the `database` object. These are covered by different plugins, which can be configured for the `KustoDatabaseHandlerFactory`.
1010

1111
```csharp
12-
1312
var dbFactory = new KustoDatabaseHandlerFactory(sp.GetService<ILogger<KustoDatabaseHandler>>())
1413
.WithPlugin<KustoDatabasePrincipalLoader>()
1514
.WithPlugin<KustoDatabaseRetentionAndCacheLoader>()
1615
.WithPlugin<KustoTableBulkLoader>()
1716
.WithPlugin<KustoFunctionBulkLoader>()
1817
.WithPlugin<KustoMaterializedViewBulkLoader>()
1918
.WithPlugin<DatabaseCleanup>()
20-
2119
```
2220

2321

22+
2423
For syncrhonizing it to files, the `YamlDatabaseHandler` and the `YamlDatabaseHandlerFactory` are the right tools. To prevent super large files, there are plugins that handle reading and writing functions, tables and materialized views to separate files and folders. They can be configured for the `YamlDatabaseHandlerFactory`.
2524

2625
```csharp
27-
2826
var yamlFactory = new YamlDatabaseHandlerFactory()
2927
.WithPlugin(new TablePlugin())
3028
.WithPlugin(new FunctionPlugin())
3129
.WithPlugin(new MaterializedViewsPlugin())
3230
.WithPlugin<DatabaseCleanup>();
33-
3431
```
3532

3633
Additional features can be added with custom plugins. A sample for `table groups`, where the some parts of the schema are defined once, but is applied for several tables can be found in [here](https://github.com/github/KustoSchemaToolsAction/blob/main/KustoSchemaCLI/Plugins/TableGroupPlugin.cs).
@@ -63,4 +60,4 @@ Currently following features are supported:
6360
* Docstring
6461
* Folder
6562

66-
The `DatabaseCleanup` will remove redundant retention and hotcache definitions. It will also pretty print KQL queries in functions, update policies and materialized views.
63+
The `DatabaseCleanup` will remove redundant retention and hotcache definitions. It will also pretty print KQL queries in functions, update policies and materialized views.

0 commit comments

Comments
 (0)