Skip to content

Commit d9e8346

Browse files
committed
Update readme
1 parent ca7ec1e commit d9e8346

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@
66

77
- [General](#general)
88
- [Usage](#usage)
9+
- [Parameter](#parameter)
10+
- [Modifier](#modifier)
11+
- [Log level](#log-level)
12+
- [Filter](#filter)
913
- [Planned features](#planned-features)
1014
- [Sources / Other](#sources--other)
1115
- [Icon](#icon)
@@ -31,9 +35,63 @@ The programme can be used in two ways:
3135
1. desktop application
3236
2. via console (*cmd*, *powershell*, etc.)
3337

38+
### Parameter
39+
40+
The following parameters are provided by the program:
41+
42+
| Parameter | Description | Example | Program |
43+
|---|---|---|---|
44+
| `-s` / `--server` | The name / path of the MS SQL Server - Mandatory for CLI / Optional for WPF App. | `-s (localdb)\MsSqlLocalDb` | Both |
45+
| `-d` / `--database` | The name of the desired database - Mandatory for CLI / Optional for WPF App. | `-d AdventureWorks` | Both |
46+
| `-o` / `--output` | The path of the output directory wich should hold the genereated classes - Mandatory. | `D:\SomeDir` | Only CLI |
47+
| `-n` / `--namespace` | The desired `namespace` which should be used - Mandatory. | `-n MyNameSpace` | Only CLI |
48+
| `-m` / `--modifier` | The desired modifier which should be used - Optional; Default = `public`. See [Modifier](#modifier). | `-m internal` | Only CLI |
49+
| `-f` / `--filter` | The filter which should be used to determine the tables - Optional; Default = *Empty*. See [Filter](#filter) | `-f Person*` | Only CLI |
50+
| `--sealed` | Adds the `sealed` modifiert to the classes - Optinal; Default = `false`. | `--sealed` | Only CLI |
51+
| `--db-model` | Adds all neded attribute to use the class with *Entity Framework Core*. - Optional; Default = `false` | `--db-model` | Only CLI |
52+
| `--column-attribute` | Adds a *Column* attribute to each property. - Optional; Default `false` | `--column-attribute` | Only CLI |
53+
| `--backing-field` | Creates a *backing field* for each property. - Optional; Default = `false` | `--backing-field` | Only CLI |
54+
| `--set-property` | Adds the `SetProperty` method to the properties. **Note**: To use this function, you need to add the [CommunityToolkit.Mvvm](https://learn.microsoft.com/de-de/dotnet/communitytoolkit/mvvm/) to your project or implement it by yourself. - Optional; Default = `false` | `--set-property` | Only CLI |
55+
| `--summary` | Adds a summary to each property and to the class. - Optional; Default = `false` | `--summary` | Only CLI |
56+
| `-c` / `--clean` | Specifies if the output directory should be *cleaned* before the class are generated. **Note**: All `*.cs` files in the specified directory will be deleted irretrievable! - Optional; Default = `false` | `-c` | Only CLI |
57+
| `--table-name` | Adds the name of the table to the class summary. - Optional; Default = `false` | `--table-name` | Only CLI |
58+
| `-l` / `--log-level` | The desired *min.* log level. See [Log level](#log-level) - Optional; Default = `2` | `-l 0` | Both |
59+
60+
#### Modifier
61+
62+
The following modifier are supported:
63+
64+
- `public`
65+
- `internal`
66+
- `protected`
67+
- `protected internal`
68+
69+
#### Log level
70+
71+
| Id | Name |
72+
|---|---|
73+
| 0 | Verbose |
74+
| 1 | Debug |
75+
| 2 | Information (default) |
76+
| 3 | Warning |
77+
| 4 | Error |
78+
| 5 | Fatal |
79+
80+
#### Filter
81+
82+
You can use the filter als follows:
83+
84+
| Example | Description |
85+
|---|---|
86+
| `value` | The name of the table must match the filter value. |
87+
| `value*` | The name of the table must beginn with the filter value. |
88+
| `*value` | The name of the table must end with the filter value. |
89+
| `*value*` | The name of the table must contain the filter value. |
90+
3491
## Planned features
3592

3693
1. Color selection
94+
2. Update info
3795

3896
## Sources / Other
3997

0 commit comments

Comments
 (0)