You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@
2
2
3
3
This C# project provides functionality to work with schemas in Azure Data Explorer (Kusto). You can load a schema from yaml files or a database to the interal data structure. This can be used for creating diffs of two databases as scripts or markdown, and also to write it back to files or update schemas in a database.
4
4
5
-
A second project "[KustoSchemaToolsAction](https://github.com/github/KustoSchemaToolsAction)" wraps that into CLI tool inside a docker container for usage in GitHub Actions.
5
+
A second project "[KustoSchemaToolsAction](https://github.com/github/KustoSchemaToolsAction)" wraps that into a CLI tool inside a docker container for usage in GitHub Actions.
6
6
7
7
## Getting started
8
8
9
-
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`.
9
+
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 all relevant information from a kusto database into the `database` object. These are covered by different plugins, which can be configured for the `KustoDatabaseHandlerFactory`.
@@ -20,7 +20,7 @@ var dbFactory = new KustoDatabaseHandlerFactory(sp.GetService<ILogger<KustoDatab
20
20
21
21
22
22
23
-
Forsyncrhonizingittofiles, the `YamlDatabaseHandler` andthe `YamlDatabaseHandlerFactory` aretherighttools. Topreventsuperlargefiles, therearepluginsthathandlereadingandwritingfunctions, tablesandmaterializedviewstoseparatefilesandfolders. Theycanbeconfiguredfor the `YamlDatabaseHandlerFactory`.
23
+
Forsynchronizingittofiles, the `YamlDatabaseHandler` andthe `YamlDatabaseHandlerFactory` aretherighttools. Topreventsuperlargefiles, therearepluginsthathandlereadingandwritingfunctions, tablesandmaterializedviewstoseparatefilesandfolders. Theycanbeconfiguredfor the `YamlDatabaseHandlerFactory`.
24
24
25
25
```csharp
26
26
var yamlFactory = new YamlDatabaseHandlerFactory()
@@ -30,7 +30,7 @@ var yamlFactory = new YamlDatabaseHandlerFactory()
30
30
.WithPlugin<DatabaseCleanup>();
31
31
```
32
32
33
-
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).
33
+
Additional features can be added with custom plugins. A sample for `table groups`, where some parts of the schema are defined once, but are applied for several tables can be found in [here](https://github.com/github/KustoSchemaToolsAction/blob/main/KustoSchemaCLI/Plugins/TableGroupPlugin.cs).
34
34
35
35
The `KustoSchemaHandler` is the central place for synching schemas between yaml and a database. It offers functions for generating changes formatted in markdown, writing a database to yaml files and applying changes from yaml files to a database.
36
36
@@ -63,14 +63,14 @@ Currently following features are supported:
63
63
* Storage / Delta / SQL
64
64
* Folder
65
65
* Docstring
66
-
*Continous Exports
66
+
*Continuous Exports
67
67
* Entity Groups
68
68
* Deleting existing items using deletions in the database definition
69
69
* Tables
70
70
* Columns
71
71
* Functions
72
72
* Materialized Views
73
73
* Extenal Tables
74
-
*Continous Exports
74
+
*Continuous Exports
75
75
76
-
The `DatabaseCleanup` will remove redundant retention and hotcache definitions. It will also pretty print KQL queries in functions, update policies,materialized views and continous exports.
76
+
The `DatabaseCleanup` will remove redundant retention and hotcache definitions. It will also pretty print KQL queries in functions, update policies,materialized views and continuous exports.
0 commit comments