Правка README.md, перемещение sql-схемы в другую папку
This commit is contained in:
@@ -9,26 +9,17 @@
|
||||
- `DATA_DIR` - путь к папке для распаковки репозиториев обрабатываемых данных;
|
||||
- `OUTPUT_DIR` - путь к месту сохранения схем;
|
||||
- `DATABASE_CONNECTION` - строка подключения к БД (только PostreSQL).
|
||||
- Для создания структуры БД в командной строке запустите `dotnet ef database update`.
|
||||
- Проект готов к работе.
|
||||
- Перейдите а папку `Pf2eModel` (`cd ../Pf2eModel`) и запустите `dotnet ef database update` для создания структуры БД в командной строке.
|
||||
|
||||
## Роли проектов
|
||||
|
||||
- `Pf2eModel` - общая ORM-структура модели.
|
||||
- `Pf2eDataScrapper` - загрузчик и обработчик данных.
|
||||
- `Pf2eViewer` - программа отображения базы данных.
|
||||
|
||||
## Общая структура
|
||||
|
||||
### `SchemaBuilder`
|
||||
|
||||
Классы обработки вводимых JSON-данных и создание схемы данных для использовании при формировании обработчиков данных.
|
||||
|
||||
Использование:
|
||||
```csharp
|
||||
SchemaNode schema = new(); // Создание схемы данных
|
||||
|
||||
data = JObject.Parse(reader.ReadToEnd()); // Загрузка данных
|
||||
|
||||
schema.AddValue(data); // Добавление данных
|
||||
```
|
||||
|
||||
### `Model`
|
||||
### `Pf2eModel`
|
||||
|
||||
Набор классов модели ORM EntityFramework.
|
||||
|
||||
@@ -42,14 +33,32 @@ schema.AddValue(data); // Добавление данных
|
||||
- `Enum` содержит описание всех перечислений, использующихся в модели.
|
||||
- `Structure` содержит все основные типы, которые связаны 1-к-1 с `Entity` (для указания этого используется интерфейс `IEntity`).
|
||||
|
||||
### `Migrations`
|
||||
#### `Migrations`
|
||||
|
||||
Миграции БД, генерируются в автомотическом режиме.
|
||||
|
||||
### `Importers`
|
||||
### `Pf2eDataScrapper`
|
||||
|
||||
#### `SchemaBuilder`
|
||||
|
||||
Классы обработки вводимых JSON-данных и создание схемы данных для использовании при формировании обработчиков данных.
|
||||
|
||||
Использование:
|
||||
```csharp
|
||||
SchemaNode schema = new(); // Создание схемы данных
|
||||
|
||||
data = JObject.Parse(reader.ReadToEnd()); // Загрузка данных
|
||||
|
||||
schema.AddValue(data); // Добавление данных
|
||||
```
|
||||
|
||||
#### `Importers`
|
||||
|
||||
Классы загрузки и обработки данных.
|
||||
|
||||
### `Pf2eViewer`
|
||||
|
||||
Программа для отображения данных. Не требует дополнительной настройки.
|
||||
|
||||
# TODO
|
||||
|
||||
|
||||
Reference in New Issue
Block a user