-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathreference.qmd
1639 lines (1287 loc) · 78.2 KB
/
reference.qmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
title: "Referenzdokumentation"
order: 1
---
Das Datenmanagement-Tool _GRETL_ ist ein Werkzeug, das für Datenimports, Datenumbauten (Modellumbau) und Datenexports eingesetzt wird. _GRETL_ führt Jobs aus, wobei ein Job aus mehreren atomaren Tasks besteht. Damit ein Job als vollständig ausgeführt gilt, muss jeder zum Job gehörende Task vollständig ausgeführt worden sein. Schlägt ein Task fehl, gilt auch der Job als fehlgeschlagen.
Ein Job besteht aus einem oder mehreren Tasks, die gemäss einem gerichteten Graphen (Directed Acyclic Graph; DAG) miteinander verknüpft sind.
Ein Job kann aus z.B. aus einer linearen Kette von Tasks bestehen:
```
Task 1 – Task 2 – Task 3 – Task n
```
Beispiel: Datenimport aus INTERLIS-Datei – Datenumbau – Datenexport nach Shapefile.
Ein Job kann sich nach einem Task aber auch auf zwei oder mehr verschiedene weitere Tasks verzweigen:
```
- Task 2 – Task 3 – Task n
Task 1 –
– Task 4 – Task 5 – Task m
```
Beispiel: Datenimport aus INTERLIS-Datei – Datenumbau in Zielschema 1 und ein zweiter Datenumbau in Zielschema 2.
Es ist auch möglich, dass zuerst zwei oder mehr Tasks unabhängig voneinander ausgeführt werden müssen, bevor ein einzelner weiterer Task ausgeführt wird.
```
Task 1 –
– Task 3 – Task 4 – Task n
Task 2 –
```
Die Tasks eines Jobs werden per Konfigurationsfile konfiguriert.
## Systemanforderungen
Um die aktuelle Version von _GRETL_ auszuführen, muss
- die Java-Laufzeitumgebung (JRE), Version 1.8, und
- _Gradle_, Version 5.1 oder neuer, aber kleiner Version 6, auf dem System installiert sein.
Die Java-Laufzeitumgebung (JRE) kann z.B. [hier](https://adoptium.net/temurin/releases/?version=8) gratis bezogen werden.
Die Gradle-Software kann auf der Website [https://gradle.org/](https://gradle.org/install/) gratis bezogen werden.
## Installation
_GRETL_ selbst muss als Gradle-Plugin nicht explizit installiert werden, sondern wird dynamisch durch das Internet bezogen.
Um gretl auszuführen, geben Sie auf der Kommandozeile folgendes Kommando ein (wobei ``jobfolder`` der absolute Pfad
zu ihrem Verzeichnis mit der Job Konfiguration ist.)
```bash
gradle --project-dir jobfolder
```
Alternativ können Sie auch ins Verzeichnis mit der Job Konfiguration wechseln, und da das Kommando ``gradle`` ohne
Argument verwenden:
```bash
cd jobfolder
gradle
```
## Tasks
### Av2ch
Transformiert eine INTERLIS-1-Transferdatei im kantonalen AV-DM01-Modell in das Bundesmodell. Unterstützt werden die Sprachen _Deutsch_ und _Italienisch_ und der Bezugrahmen _LV95_. Getestet mit Daten aus den Kantonen Solothurn, Glarus und Tessin. Weitere Informationen sind in der Basisbibliothek zu finden: [https://github.com/sogis/av2ch](https://github.com/sogis/av2ch).
Das Bundes-ITF hat denselben Namen wie das Kantons-ITF.
Aufgrund der sehr vielen Logging-Messages einer verwendeten Bibliothek, wird der `System.err`-Ouput nach `dev/null` [gemappt](https://github.com/sogis/av2ch/blob/master/src/main/java/ch/so/agi/av/Av2ch.java#L75) .
```groovy
task transform(type: Av2ch) {
inputFile = file("254900.itf")
outputDirectory = file("output")
}
```
Parameter | Datentyp | Beschreibung
----------|----------|-------------
inputFile | `File` | Name der zu transformierenden ITF-Datei.
outputDirectory | `File` | Name des Verzeichnisses in das die zu erstellende Datei geschrieben wird.
modeldir | `String`| INTERLIS-Modellablage. String separiert mit Semikolon (analog ili2db, ilivalidator).
zip | `Boolean ` | Die zu erstellende Datei wird gezippt (Default: false).
### Av2geobau
Av2geobau konvertiert eine INTERLIS-Transferdatei (itf) in eine DXF-Geobau Datei.
Av2geobau funktioniert ohne Datenbank.
Die ITF-Datei muss dem Modell DM01AVCH24LV95D entsprechen. Die Daten werden nicht validiert.
Die Datenstruktur der DXF-Datei ist im Prinzip sehr einfach: Die verschiedenen Informationen aus dem Datenmodell DM01 werden in verschiedene DXF-Layer abgebildet, z.B. die begehbaren LFP1 werden in den Layer "01111" abgebildet. Oder die Gebäude in den Layer "01211".
Der Datenumbau ist nicht konfigurierbar.
```groovy
task av2geobau(type: Av2geobau){
itfFiles = "ch_254900.itf"
dxfDirectory = "./out/"
}
```
Es können auch mehrere Dateien angegeben werden.
```groovy
task av2geobau(type: Av2geobau){
itfFiles = fileTree(".").matching {
include"*.itf"
}
dxfDirectory = "./out/"
}
```
Parameter | Beschreibung
-------------|-------------------
itfFiles | ITF-Datei, die nach DXF transformiert werden soll. Es können auch mehrere Dateien angegeben werden.
dxfDirectory | Verzeichnis, in das die DXF-Dateien gespeichert werden.
modeldir | Dateipfade, die Modell-Dateien (ili-Dateien) enthalten. Mehrere Pfade können durch Semikolon ‚;‘ getrennt werden. Es sind auch URLs von Modell-Repositories möglich. Default: ``%ITF_DIR;http://models.interlis.ch/``. ``%ITF_DIR`` ist ein Platzhalter für das Verzeichnis mit der ITF-Datei.
logFile | Schreibt die log-Meldungen der Konvertierung in eine Text-Datei.
proxy | Proxy Server für den Zugriff auf Modell Repositories
proxyPort | Proxy Port für den Zugriff auf Modell Repositories
zip | Die zu erstellende Datei wird gezippt und es werden zusätzliche Dateien (Musterplan, Layerbeschreibung, Hinweise) hinzugefügt (Default: false).
### Csv2Excel (incubating)
Konvertiert eine CSV-Datei in eine Excel-Datei (*.xlsx). Datentypen werden anhand eines INTERLIS-Modelles eruiert. Fehlt das Modell, wird alles als Text gespeichert. Die Daten werden vollständig im Speicher vorgehalten. Falls grosse Dateien geschrieben werden müssen, kann das zu Problemen führen. Dann müsste die Apache POI SXSSF Implementierung (Streaming) verwendet werden.
Beispiel:
```groovy
task convertData(type: Csv2Excel) {
csvFile = file("./20230124_sap_Gebaeude.csv")
firstLineIsHeader = true
valueDelimiter = null
valueSeparator = ";"
encoding = "ISO-8859-1";
models = "SO_HBA_Gebaeude_20230111";
outputDir = file(".");
}
```
Parameter | Beschreibung
----------|-------------------
csvFile | CSV-Datei, die konvertiert werden soll.
firstLineIsHeader | Definiert, ob eine Headerzeile geschrieben werden soll, oder nicht. Default: true
valueDelimiter | Zeichen, das am Anfang und Ende jeden Wertes geschrieben werden soll. Default ``"``
valueSeparator | Zeichen, das als Trennzeichen zwischen den Werten verwendet werden soll. Default: ``,``
encoding | Zeichencodierung der CSV-Datei, z.B. ``"UTF-8"``. Default: Systemeinstellung
models | INTERLIS-Modell für Definition der Datentypen in der Excel-Datei.
modeldir | Dateipfade, die Modell-Dateien (ili-Dateien) enthalten. Mehrere Pfade können durch Semikolon ";" getrennt werden. Es sind auch URLs von Modell-Repositories möglich.
outputDir | Verzeichnis, in das die Excel-Datei gespeichert wird. Default: Verzeichnis, in dem die CSV-Datei vorliegt.
### Csv2Parquet (incubating)
Konvertiert eine CSV-Datei in eine Parquet-Datei. Datentypen werden anhand eines INTERLIS-Modelles eruiert. Fehlt das Modell, wird alles als Text gespeichert.
Beispiel:
```groovy
task convertData(type: Csv2Parquet) {
csvFile = file("./20230124_sap_Gebaeude.csv")
firstLineIsHeader = true
valueDelimiter = null
valueSeparator = ";"
encoding = "ISO-8859-1";
models = "SO_HBA_Gebaeude_20230111";
outputDir = file(".");
}
```
Parameter | Beschreibung
----------|-------------------
csvFile | CSV-Datei, die konvertiert werden soll.
firstLineIsHeader | Definiert, ob eine Headerzeile geschrieben werden soll, oder nicht. Default: true
valueDelimiter | Zeichen, das am Anfang und Ende jeden Wertes geschrieben werden soll. Default ``"``
valueSeparator | Zeichen, das als Trennzeichen zwischen den Werten verwendet werden soll. Default: ``,``
encoding | Zeichencodierung der CSV-Datei, z.B. ``"UTF-8"``. Default: Systemeinstellung
models | INTERLIS-Modell für Definition der Datentypen in der Parquet-Datei.
modeldir | Dateipfade, die Modell-Dateien (ili-Dateien) enthalten. Mehrere Pfade können durch Semikolon ";" getrennt werden. Es sind auch URLs von Modell-Repositories möglich.
outputDir | Verzeichnis, in das die Parquet-Datei gespeichert wird. Default: Verzeichnis, in dem die CSV-Datei vorliegt.
### CsvExport
Daten aus einer bestehenden Datenbanktabelle werden in eine CSV-Datei exportiert.
Beispiel:
```groovy
def db_uri = 'jdbc:postgresql://localhost/gretldemo'
def db_user = "dmluser"
def db_pass = "dmluser"
task csvexport(type: CsvExport){
database = [db_uri, db_user, db_pass]
schemaName = "csvexport"
tableName = "exportdata"
firstLineIsHeader=true
attributes = [ "t_id","Aint"]
dataFile = "data.csv"
}
```
Parameter | Beschreibung
----------|-------------------
database | Datenbank aus der exportiert werden soll.
dataFile | Name der CSV-Datei, die erstellt werden soll.
tableName | Name der DB-Tabelle, die exportiert werden soll
schemaName | Name des DB-Schemas, in dem die DB-Tabelle ist.
firstLineIsHeader | Definiert, ob eine Headerzeile geschrieben werden soll, oder nicht. Default: true
valueDelimiter | Zeichen, das am Anfang und Ende jeden Wertes geschrieben werden soll. Default ``"``
valueSeparator | Zeichen, das als Trennzeichen zwischen den Werten verwendet werden soll. Default: ``,``
attributes | Spalten der DB-Tabelle, die exportiert werden sollen. Definiert die Reihenfolge der Spalten in der CSV-Datei. Default: alle Spalten
encoding | Zeichencodierung der CSV-Datei, z.B. ``"UTF-8"``. Default: Systemeinstellung
Geometriespalten können nicht exportiert werden.
### CsvImport
Daten aus einer CSV-Datei werden in eine bestehende Datenbanktabelle importiert.
Beispiel:
```groovy
def db_uri = 'jdbc:postgresql://localhost/gretldemo'
def db_user = "dmluser"
def db_pass = "dmluser"
task csvimport(type: CsvImport){
database = [db_uri, db_user, db_pass]
schemaName = "csvimport"
tableName = "importdata"
firstLineIsHeader=true
dataFile = "data1.csv"
}
```
Parameter | Beschreibung
----------|-------------------
database | Datenbank in die importiert werden soll
dataFile | Name der CSV-Datei, die gelesen werden soll
tableName | Name der DB-Tabelle, in die importiert werden soll
schemaName | Name des DB-Schemas, in dem die DB-Tabelle ist.
firstLineIsHeader | Definiert, ob die CSV-Datei einer Headerzeile hat, oder nicht. Default: true
valueDelimiter | Zeichen, das am Anfang und Ende jeden Wertes vorhanden ist. Default ``"``
valueSeparator | Zeichen, das als Trennzeichen zwischen den Werten interpretiert werden soll. Default: ``,``
encoding | Zeichencodierung der CSV-Datei, z.B. ``"UTF-8"``. Default: Systemeinstellung
batchSize | Anzahl der Records, die pro Batch in die Ziel-Datenbank geschrieben werden (Standard: 5000).
Die Tabelle kann weitere Spalten enthalten, die in der CSV-Datei nicht vorkommen. Sie müssen aber NULLable sein, oder einen Default-Wert definiert haben.
Geometriepalten können nicht importiert werden.
Die Gross-/Kleinschreibung der CSV-Spaltennamen wird für die Zuordnung zu den DB-Spalten ignoriert.
### CsvValidator
Prüft eine CSV-Datei gegenüber einem INTERLIS-Modell. Basiert auf dem [_ilivalidator_](https://github.com/claeis/ilivalidator). Das Datenmodell darf die OID nicht als UUID modellieren (`OID AS INTERLIS.UUIDOID`).
Beispiel:
```groovy
task validate(type: CsvValidator){
models = "CsvModel"
firstLineIsHeader=true
dataFiles = ["data1.csv"]
}
```
Parameter | Beschreibung
----------|-------------------
dataFiles | Liste der CSV-Dateien, die validiert werden sollen. Eine leere Liste ist kein Fehler.
models | INTERLIS-Modell, gegen das die Dateien geprüft werden sollen (mehrere Modellnamen durch Semikolon trennen). Default: Der Name der CSV-Datei.
modeldir | Dateipfade, die Modell-Dateien (ili-Dateien) enthalten. Mehrere Pfade können durch Semikolon ‚;‘ getrennt werden. Es sind auch URLs von Modell-Repositories möglich. Default: ``%XTF_DIR;http://models.interlis.ch/``. ``%XTF_DIR`` ist ein Platzhalter für das Verzeichnis mit der CSV-Datei.
configFile | Konfiguriert die Datenprüfung mit Hilfe einer TOML-Datei (um z.B. die Prüfung von einzelnen Constraints auszuschalten). siehe https://github.com/claeis/ilivalidator/blob/master/docs/ilivalidator.rst#konfiguration
forceTypeValidation | Ignoriert die Konfiguration der Typprüfung aus der TOML-Datei, d.h. es kann nur die Multiplizität aufgeweicht werden. Default: false
disableAreaValidation | Schaltet die AREA-Topologieprüfung aus. Default: false
multiplicityOff | Schaltet die Prüfung der Multiplizität generell aus. Default: false
allObjectsAccessible | Mit der Option nimmt der Validator an, dass er Zugriff auf alle Objekte hat. D.h. es wird z.B. auch die Multiplizität von Beziehungen auf externe Objekte geprüft. Default: false
skipPolygonBuilding | Schaltet die Bildung der Polygone aus (nur ITF). Default: false
logFile | Schreibt die log-Meldungen der Validierung in eine Text-Datei.
xtflogFile | Schreibt die log-Meldungen in eine INTERLIS 2-Datei. Die Datei result.xtf entspricht dem Modell [IliVErrors](http://models.interlis.ch/models/tools/IliVErrors.ili).
pluginFolder | Verzeichnis mit JAR-Dateien, die Zusatzfunktionen enthalten.
proxy | Proxy Server für den Zugriff auf Modell Repositories
proxyPort | Proxy Port für den Zugriff auf Modell Repositories
failOnError | Steuert, ob der Task bei einem Validierungsfehler fehlschlägt. Default: true
validationOk | OUTPUT: Ergebnis der Validierung. Nur falls failOnError=false
firstLineIsHeader | Definiert, ob die CSV-Datei einer Headerzeile hat, oder nicht. Default: true
valueDelimiter | Zeichen, das am Anfang und Ende jeden Wertes vorhanden ist. Default ``"``
valueSeparator | Zeichen, das als Trennzeichen zwischen den Werten interpretiert werden soll. Default: ``,``
encoding | Zeichencodierung der CSV-Datei, z.B. ``"UTF-8"``. Default: Systemeinstellung
Falls die CSV-Datei eine Header-Zeile enthält (mit den Spaltennamen), wird im gegebenen Modell eine Klasse gesucht, welche die Header-Spaltennamen enthält (Gross-/Kleinschreibung sowie optionale "Spalten" der Modell-Klasse werden ignoriert). Wird keine solche Klasse gefunden, gilt das als Validierungsfehler.
Falls die CSV-Datei keine Header-Zeile enthält (mit den Spaltennamen), wird im gegebenen Modell eine Klasse gesucht, die die selbe Anzahl Attribute hat. Wird keine solche Klasse gefunden, gilt das als Validierungsfehler.
Die Prüfung von gleichzeitig mehreren CSV-Dateien führt zu Fehlermeldungen wie `OID o3158 of object <Modelname>.<Topicname>.<Klassenname> already exists in ...`. Beim Öffnen und Lesen einer CSV-Datei wird immer der Zähler, der die interne (in der CSV-Datei nicht vorhandene) `OID` generiert, zurückgesetzt. Somit kann immer nur eine CSV-Datei pro Task geprüft werden.
### Curl
Simuliert mit einem HttpClient einige Curl-Befehle.
Beispiele:
```groovy
import ch.so.agi.gretl.tasks.Curl.MethodType;
task uploadData(type: Curl) {
serverUrl = "https://geodienste.ch/data_agg/interlis/import"
method = MethodType.POST
formData = ["topic": "npl_waldgrenzen", "lv95_file": file("./test.xtf.zip"), "publish": "true", "replace_all": "true"]
user = "fooUser"
password = "barPwd"
expectedStatusCode = 200
expectedBody = "\"success\":true"
}
```
```groovy
import ch.so.agi.gretl.tasks.Curl.MethodType;
task uploadData(type: Curl) {
serverUrl = "https://testweb.so.ch/typo3/api/digiplan"
method = MethodType.POST
headers = ["Content-Type": "application/xml", "Content-Encoding": "gzip"]
dataBinary = file("./planregister.xml.gz")
user = "fooUser"
password = "barPwd"
expectedStatusCode = 202
}
```
```groovy
import ch.so.agi.gretl.tasks.Curl.MethodType;
task downloadData(type: Curl) {
serverUrl = "https://raw.githubusercontent.com/sogis/gretl/master/README.md"
method = MethodType.GET
outputFile = file("./README.md")
expectedStatusCode = 200
}
```
Parameter | Beschreibung
----------|-------------------
serverUrl | Die URL des Servers inklusive Pfad und Queryparameter.
method | HTTP-Request-Methode. Unterstützt werden `GET` und `POST`.
expectedStatusCode | Erwarteter Status Code, der vom Server zurückgeliefert wird.
expectedBody | Erwarteter Text, der vom Server als Body zurückgelieferd wird. (optional)
formData | Form data parameters. Entspricht `curl [URL] -F key1=value1 -F file1=@my_file.xtf`. (optional)
dataBinary | Datei, die hochgeladen werden soll. Entspricht `curl [URL] --data-binary`. (optional)
headers | Request-Header. Entspricht `curl [URL] -H ... -H ...`. (optional)
user | Benutzername. Wird zusammen mit `password` in einen Authorization-Header umgewandelt. Entspricht `curl [URL] -u user:password`. (optional)
password | Passwort. Wird zusammen mit `user` in einen Authorization-Header umgewandelt. Entspricht `curl [URL] -u user:password`. (optional)
outputFile | Datei, in die der Output gespeichert wird. Entspricht `curl [URL] -o`. (optional)
### DatabaseDocumentExport (Experimental)
Speichert Dokumente, deren URL in einer Spalte einer Datenbanktabelle gespeichert sind, in einem lokalen Verzeichnis. Zukünftig und bei Bedarf kann der Task so erweitert werden, dass auch BLOBs aus der Datenbank gespeichert werden können.
Redirect von HTTP nach HTTPS funktionieren nicht. Dies [korrekterweise](https://stackoverflow.com/questions/1884230/httpurlconnection-doesnt-follow-redirect-from-http-to-https) (?) wegen der verwendeten Java-Bibliothek.
Wegen der vom Kanton Solothurn eingesetzten self-signed Zertifikate muss ein unschöner Handstand gemacht werden. Leider kann dieser Usecase schlecht getestet werden, da die Links nur in der privaten Zone verfügbar sind und die zudem noch häufig ändern können. Manuell getestet wurde es jedoch.
Als Dateiname wird der letzte Teil des URL-Pfades verwendet, z.B. `https://artplus.verw.rootso.org/MpWeb-apSolothurnDenkmal/download/2W8v0qRZQBC0ahDnZGut3Q?mode=gis` wird mit den Prefix und Extension zu `ada_2W8v0qRZQBC0ahDnZGut3Q.pdf`.
Es wird `DISTINCT ON (<documentColumn>)` und ein Filter `WHERE <documentColumn> IS NOT NULL` verwendet.
Beispiel:
```groovy
def db_uri = 'jdbc:postgresql://localhost/gretldemo'
def db_user = "dmluser"
def db_pass = "dmluser"
task exportDocuments(type: DatabaseDocumentExport){
database = [db_uri, db_user, db_pass]
qualifiedTableName = "ada_denkmalschutz.fachapplikation_rechtsvorschrift_link"
documentColumn = "multimedia_link"
targetDir = file(".")
fileNamePrefix = "ada_"
fileNameExtension = "pdf"
}
```
Parameter | Beschreibung
----------|-------------------
database | Datenbank aus der die Dokumente exportiert werden sollen.
qualifiedTableName | Qualifizierter Tabellenname
documentColumn | DB-Tabellenspalte mit dem Dokument resp. der URL zum Dokument.
targetDir | Verzeichnis in das die Dokumente exportiert werden sollen.
fileNamePrefix | Prefix für Dateinamen (optional)
fileNameExtension | Dateinamen-Extension (optional)
### Db2Db
Dies ist prinzipiell ein 1:1-Datenkopie, d.h. es findet kein Datenumbau statt, die Quell- und die Ziel-Tabelle hat jeweils identische Attribute. Es werden auf Seite Quelle in der Regel also simple SELECT-Queries ausgeführt und die Resultate dieser Queries in Tabellen der Ziel-DB eingefügt. Unter bestimmten Bedingungen (insbesondere wenn es sich um einen wenig komplexen Datenumbau handelt), kann dieser Task aber auch zum Datenumbau benutzt werden.
Die Queries können auf mehrere .sql-Dateien verteilt werden, d.h. der Task muss die Queries mehrerer .sql-Dateien zu einer Transaktion kombinieren können. Jede .sql-Datei gibt genau eine Resultset (RAM-Tabelle) zurück. Das Resultset wird in die konfigurierte Zieltabelle geschrieben. Die Beziehungen sind: Eine bis mehrere Quelltabellen ergeben ein Resultset; das Resultset entspricht bezüglich den Attributen genau der Zieltabelle und wird 1:1 in diese geschrieben. Der Db2Db-Task verarbeitet innerhalb einer Transaktion 1-n Resultsets und wird entsprechend auch mit 1-n SQL-Dateien konfiguriert.
Die Reihenfolge der .sql-Dateien ist relevant. Dies bedeutet, dass die SQL-Befehle der zuerst angegebenen .sql-Datei zuerst ausgeführt werden müssen, danach die SQL-Befehle der an zweiter Stelle angegebenen .sql-Datei, usw.
Es ist auch möglich, in den .sql-Dateien mehr als nur ein SELECT-Query zu formulieren, z.B. ein vorgängiges DELETE.
Alle SELECT-Statements werden in einer Transaktion ausgeführt werden, damit ein konsistenter Datenstand gelesen wird. Alle INSERT-Statements werden in einer Transaktion ausgeführt werden, damit bei einem Fehler der bisherige Datenstand bestehen bleibt und also kein unvollständiger Import zurückgelassen wird.
Damit dieselbe .sql-Datei für verschiedene Datensätze benutzt werden kann, ist es möglich innerhalb der .sql-Datei Parameter zu verwenden und diesen Parametern beim Task einen konkreten Wert zuzuweisen. Innerhalb der .sql-Datei werden Paramter mit folgender Syntax verwendet: ``${paramName}``.
```groovy
def db_uri = 'jdbc:postgresql://localhost/gretldemo'
def db_user = "dmluser"
def db_pass = "dmluser"
task transferSomeData(type: Db2Db) {
sourceDb = [db_uri, db_user, db_pass]
targetDb = ['jdbc:sqlite:gretldemo.sqlite',null,null]
sqlParameters = [dataset:'Olten']
transferSets = [
new TransferSet('some.sql', 'albums_dest', true)
];
}
```
Damit mit einer einzigen Task-Definition mehrere Datensätze verarbeitet werden können, kann auch eine Liste von Parametern angegeben werden.
```groovy
def db_uri = 'jdbc:postgresql://localhost/gretldemo'
def db_user = "dmluser"
def db_pass = "dmluser"
task transferSomeData(type: Db2Db) {
sourceDb = [db_uri, db_user, db_pass]
targetDb = ['jdbc:sqlite:gretldemo.sqlite',null,null]
sqlParameters = [[dataset:'Olten'],[dataset:'Grenchen']]
transferSets = [
new TransferSet('some.sql', 'albums_dest', true)
];
}
```
Parameter | Beschreibung
----------|-------------------
sourceDb | Datenbank aus der gelesen werden soll
targetDb | Datenbank in die geschrieben werden soll
transferSets | Eine Liste von ``TransferSet``s.
sqlParameters | Eine Map mit Paaren von Parameter-Name und Parameter-Wert (``Map<String,String>``). Oder eine Liste mit Paaren von Parameter-Name und Parameter-Wert (``List<Map<String,String>>``).
batchSize | Anzahl der Records, die pro Batch in die Ziel-Datenbank geschrieben werden (Standard: 5000). Für sehr grosse Tabellen muss ein kleinerer Wert gewählt werden.
fetchSize | Anzahl der Records, die auf einmal vom Datenbank-Cursor von der Quell-Datenbank zurückgeliefert werden (Standard: 5000). Für sehr grosse Tabellen muss ein kleinerer Wert gewählt werden.
Eine ``TransferSet`` ist
- eine SQL-Datei (mit SQL-Anweisungen zum Lesen der Daten aus der sourceDb),
- dem Namen der Ziel-Tabelle in der targetDb, und
- der Angabe ob in der Ziel-Tabelle vor dem INSERT zuerst alle Records gelöscht werden sollen.
- einem optionalen vierten Parameter, der verwendet werden kann um den zu erzeugenden SQL-Insert-String
zu beeinflussen, u.a. um einen WKT-Geometrie-String in eine PostGIS-Geometrie umzuwandeln
Beispiel, Umwandlung Rechtswert/Hochwertspalten in eine PostGIS-Geometrie
(siehe auch Gretl-Job [afu_onlinerisk_transfer](https://github.com/sogis/gretljobs/tree/main/afu_onlinerisk_transfer) der eine Punktgeometriespalten aus einer Nicht-Postgis-DB übernimmt):
```
new TransferSet('untersuchungseinheit.sql', 'afu_qrcat_v1.onlinerisk_untersuchungseinheit', true, (String[])["geom:wkt:2056"])
```
"geom" ist der Geometrie-Spalten-Name der verwendet wird.
Dazugehöriger Auszug aus SQL-Datei zur Erzeugung des WKT-Strings mit Hilfe von concatenation:
```
'Point(' || ue.koordinate_x::text || ' ' || ue.koordinate_y::text || ')' AS geom
```
Unterstützte Datenbanken: PostgreSQL, SQLite und Oracle. Der Oracle-JDBC-Treiber muss jedoch selber installiert werden (Ausgenommen vom Docker-Image).
### FtpDelete
Löscht Daten auf einem FTP-Server.
Beispiel, löscht alle Daten in einem Verzeichnis:
```groovy
task ftpdelete(type: FtpDelete) {
server= "ftp.server.org"
user= "Hans"
password= "dummy"
remoteDir = "\\dm01avso24lv95\\itf"
remoteFile = fileTree(pathToTempFolder) { include '*.zip' }
//remoteFile = "*.zip"
}
```
Um bestimmte Dateien zu löschen:
```groovy
task ftpdownload(type: FtpDownload){
server= "ftp.server.org"
user= "Hans"
password= "dummy"
remoteDir = "\\dm01avso24lv95\\itf"
remoteFile = "*.zip"
}
```
Um heruntergeladene Daten zu löschen:
```groovy
task ftpdownload(type: FtpDownload){
server= "ftp.server.org"
user= "Hans"
password= "dummy"
remoteDir = "\\dm01avso24lv95\\itf"
remoteFile = fileTree(pathToDownloadFolder) { include '*.zip' }
}
```
Parameter | Beschreibung
------------------------|-------------------
server | Name des Servers (ohne ftp://)
user | Benutzername auf dem Server
password | Passwort für den Zugriff auf dem Server
remoteDir | Verzeichnis auf dem Server
remoteFile | Dateiname oder Liste der Dateinamen auf dem Server (kann auch ein Muster sein (* oder ?)). Ohne diesen Parameter werden alle Dateien aus dem Remoteverzeichnis gelöscht.
systemType | UNIX oder WINDOWS. Default ist UNIX.
fileSeparator | Default ist '/'. (Falls systemType Windows ist, ist der Default '\\'.
passiveMode | Aktiv oder Passiv Verbindungsmodus. Default ist Passiv (true)
controlKeepAliveTimeout | Timeout bis ein NOOP über den Kontroll-Kanal versendet wird. Default ist 300s (=5 Minuten)
### FtpDownload
Lädt alle Dateien aus dem definierten Verzeichnis des Servers in ein lokales Verzeichnis herunter.
Beispiel:
```groovy
task ftpdownload(type: FtpDownload){
server= "ftp.server.org"
user= "Hans"
password= "dummy"
localDir= "downloads"
remoteDir= ""
}
```
Um eine bestimmte Datei herunterzuladen:
```groovy
task ftpdownload(type: FtpDownload){
server="ftp.infogrips.ch"
user= "Hans"
password= "dummy"
systemType="WINDOWS"
localDir= "downloads"
remoteDir="\\dm01avso24lv95\\itf"
remoteFile="240100.zip"
}
```
Parameter | Beschreibung
------------------------|-------------------
server | Name des Servers (ohne ftp://)
user | Benutzername auf dem Server
password | Passwort für den Zugriff auf dem Server
localDir | Lokales Verzeichnis indem die Dateien gespeichert werden
remoteDir | Verzeichnis auf dem Server
remoteFile | Dateiname oder Liste der Dateinamen auf dem Server (kann auch ein Muster sein (* oder ?)). Ohne diesen Parameter werden alle Dateien aus dem Remoteverzeichnis heruntergeladen.
systemType | UNIX oder WINDOWS. Default ist UNIX.
fileType | ASCII oder BINARY. Default ist ASCII.
fileSeparator | Default ist '/'. (Falls systemType Windows ist, ist der Default '\\'.
passiveMode | Aktiv oder Passiv Verbindungsmodus. Default ist Passiv (true)
controlKeepAliveTimeout | Timeout bis ein NOOP über den Kontroll-Kanal versendet wird. Default ist 300s (=5 Minuten)
### FtpList
Liefert eine Liste der Dateien aus dem definierten Verzeichnis des Servers.
Beispiel:
```groovy
task ftplist(type: FtpList){
server= "ftp.server.org"
user= "Hans"
password= "dummy"
remoteDir= ""
doLast {
println files
}
}
```
Parameter | Beschreibung
------------------------|-------------------
server | Name des Servers (ohne ftp://)
user | Benutzername auf dem Server
password | Passwort für den Zugriff auf dem Server
remoteDir | Verzeichnis auf dem Server
files | Liste der Dateinamen auf dem Server
systemType | UNIX oder WINDOWS. Default ist UNIX.
fileSeparator | Default ist '/'. (Falls systemType Windows ist, ist der Default '\\'.
passiveMode | Aktiv oder Passiv Verbindungsmodus. Default ist Passiv (true)
controlKeepAliveTimeout | Timeout bis ein NOOP über den Kontroll-Kanal versendet wird. Default ist 300s (=5 Minuten)
### Gpkg2Dxf
Exportiert alle Tabellen einer GeoPackage-Datei in DXF-Dateien. Als Input wird eine von _ili2gpkg_ erzeugte GeoPackage-Datei benötigt.
Es werden alle INTERLIS-Klassen exportier (`SELECT tablename FROM T_ILI2DB_TABLE_PROP WHERE setting = 'CLASS'`). Der eigentliche SELECT-Befehl ist komplizierter weil für das Layern der einzelnen DXF-Objekte das INTERLIS-Metaattribut `!!@dxflayer="true"` ausgelesen wird. Gibt es kein solches Metaattribut wird alles in den gleichen DXF-Layer (`default`) geschrieben.
**Encoding**: Die DXF-Dateien sind `ISO-8859-1` encodiert.
**Achtung**: Task sollte verbessert werden (siehe E-Mail Claude im Rahmen des Publisher-Projektes).
Beispiel:
```groovy
task gpkg2dxf(type: Gpkg2Dxf) {
dataFile = file("data.gpkg")
outputDir = file("./out/")
}
```
Parameter | Beschreibung
----------|-------------------
dataFile | GeoPackage-Datei, die nach DXF transformiert werden soll.
outputDir | Verzeichnis, in das die DXF-Dateien gespeichert werden.
### GpkgExport
Daten aus einer bestehenden Datenbanktabelle werden in eine GeoPackage-Datei exportiert.
Beispiele:
```groovy
def db_uri = 'jdbc:postgresql://localhost/gretldemo'
def db_user = "dmluser"
def db_pass = "dmluser"
task gpkgexport(type: GpkgExport){
database = [db_uri, db_user, db_pass]
schemaName = "gpkgexport"
srcTableName = "exportdata"
dataFile = "data.gpkg"
dstTableName = "exportdata"
}
```
```groovy
def db_uri = 'jdbc:postgresql://localhost/gretldemo'
def db_user = "dmluser"
def db_pass = "dmluser"
task gpkgexport(type: GpkgExport) {
database = [db_uri, db_user, db_pass]
schemaName = "gpkgexport"
srcTableName = ["exportTable1", "exportTable2"]
dataFile = "data.gpkg"
dstTableName = ["exportTable1", "exportTable2"]
}
```
Parameter | Beschreibung
----------|-------------------
database | Datenbank aus der exportiert werden soll
dataFile | Name der GeoPackage-Datei, die erstellt werden soll
srcTableName | Name der DB-Tabelle(n), die exportiert werden soll(en). String oder List.
schemaName | Name des DB-Schemas, in dem die DB-Tabelle ist.
dstTableName | Name der Tabelle(n) in der GeoPackage-Datei. String oder List.
batchSize | Anzahl der Records, die pro Batch in die Ziel-Datenbank (GeoPackage) geschrieben werden (Standard: 5000).
fetchSize | Anzahl der Records, die pro Fetch aus der Quell-Datenbank gelesen werden (Standard: 5000).
### GpkgImport
Daten aus einer GeoPackage-Datei in eine bestehende Datenbanktabelle importieren.
Beispiel:
```groovy
def db_uri = 'jdbc:postgresql://localhost/gretldemo'
def db_user = "dmluser"
def db_pass = "dmluser"
task gpkgimport(type: GpkgImport){
database = [db_uri, db_user, db_pass]
schemaName = "gpkgimport"
srcTableName = "Point"
dstTableName = "importdata"
dataFile = "point.gpkg"
}
```
Parameter | Beschreibung
----------|-------------------
database | Datenbank in die importiert werden soll
dataFile | Name der GeoPackage-Datei, die gelesen werden soll
srcTableName | Name der GeoPackage-Tabelle, die importiert werden soll
schemaName | Name des DB-Schemas, in dem die DB-Tabelle ist.
dstTableName | Name der DB-Tabelle, in die importiert werden soll
~~encoding~~ | ~~Zeichencodierung der SHP-Datei, z.B. ``"UTF-8"``. Default: Systemeinstellung~~
batchSize | Anzahl der Records, die pro Batch in die Ziel-Datenbank geschrieben werden (Standard: 5000).
fetchSize | Anzahl der Records, die pro Fetch aus der Quell-Datenbank gelesen werden (Standard: 5000).
Die Tabelle kann weitere Spalten enthalten, die in der GeoPackage-Datei nicht vorkommen. Sie müssen
aber NULLable sein, oder einen Default-Wert definiert haben.
Die Gross-/Kleinschreibung der GeoPckage-Spaltennamen wird für die Zuordnung zu den DB-Spalten ignoriert.
### Gpkg2Shp
Exportiert alle Tabellen einer GeoPackage-Datei in Shapefiles. Als Input wird eine von _ili2gpkg_ erzeugte GeoPackage-Datei benötigt.
Es werden alle INTERLIS-Klassen exportiert (`SELECT tablename FROM T_ILI2DB_TABLE_PROP WHERE setting = 'CLASS'`). Je nach, bei der Erstellung der GeoPackage-Datei, verwendeten Parametern, muss die Query angepasst werden. Es muss jedoch darauf geachtet werden, dass es nur eine Query gibt (für alle Datensätze). Für den vorgesehenen Anwendungsfall (sehr einfache, flache Modelle) dürfte das kein Problem darstellen.
**Encoding**: Die Shapefiles sind neu `UTF-8` encodiert. Standard ist `ISO-8859-1`, scheint aber v.a. in QGIS nicht standardmässig zu funktionieren (keine Umlaute).
**Achtung**: Task sollte verbessert werden (siehe E-Mail Claude im Rahmen des Publisher-Projektes).
Beispiel:
```groovy
task gpkg2shp(type: Gpkg2Shp) {
dataFile = file("data.gpkg")
outputDir = file("./out/")
}
```
Parameter | Beschreibung
----------|-------------------
dataFile | GeoPackage-Datei, die nach Shapefile transformiert werden soll.
outputDir | Verzeichnis, in das die Shapefile gespeichert werden.
### GpkgValidator
Prüft eine GeoPackage-Datei gegenüber einem INTERLIS-Modell. Basiert auf dem [_ilivalidator_](https://github.com/claeis/ilivalidator).
Beispiel:
```groovy
task validate(type: GpkgValidator){
models = "GpkgModel"
dataFiles = ["attributes.gpkg"]
tableName = "Attributes"
}
```
Parameter | Beschreibung
----------|-------------------
dataFiles | Liste der GeoPackage-Dateien, die validiert werden sollen. Eine leere Liste ist kein Fehler.
tableName | Name der Tabelle in den GeoPackage-Dateien.
models | INTERLIS-Modell, gegen das die die Dateien geprüft werden sollen (mehrere Modellnamen durch Semikolon trennen). Default: Der Name der CSV-Datei.
modeldir | Dateipfade, die Modell-Dateien (ili-Dateien) enthalten. Mehrere Pfade können durch Semikolon ‚;‘ getrennt werden. Es sind auch URLs von Modell-Repositories möglich. Default: ``%XTF_DIR;http://models.interlis.ch/``. ``%XTF_DIR`` ist ein Platzhalter für das Verzeichnis mit der SHP-Datei.
configFile | Konfiguriert die Datenprüfung mit Hilfe einer TOML-Datei (um z.B. die Prüfung von einzelnen Constraints auszuschalten). siehe https://github.com/claeis/ilivalidator/blob/master/docs/ilivalidator.rst#konfiguration
forceTypeValidation | Ignoriert die Konfiguration der Typprüfung aus der TOML-Datei, d.h. es kann nur die Multiplizität aufgeweicht werden. Default: false
disableAreaValidation | Schaltet die AREA Topologieprüfung aus. Default: false
multiplicityOff | Schaltet die Prüfung der Multiplizität generell aus. Default: false
allObjectsAccessible | Mit der Option nimmt der Validator an, dass er Zugriff auf alle Objekte hat. D.h. es wird z.B. auch die Multiplizität von Beziehungen auf externe Objekte geprüft. Default: false
logFile | Schreibt die log-Meldungen der Validierung in eine Text-Datei.
xtflogFile | Schreibt die log-Meldungen in eine INTERLIS 2-Datei. Die Datei result.xtf entspricht dem Modell IliVErrors.
pluginFolder | Verzeichnis mit JAR-Dateien, die Zusatzfunktionen enthalten.
proxy | Proxy Server für den Zugriff auf Modell Repositories
proxyPort | Proxy Port für den Zugriff auf Modell Repositories
failOnError | Steuert, ob der Task bei einem Validierungsfehler fehlschlägt. Default: true
validationOk | OUTPUT: Ergebnis der Validierung. Nur falls failOnError=false
### Gzip
Gzipped eine einzelne Datei. Es gibt einen eingebauten Tar-Task, der - nomen est omen - aber immer zuerst eine Tar-Datei erstellt.
Parameter | Beschreibung
----------|-------------------
dataFile | Datei, die gezipped werden soll.
gzipFile | Output-Datei
Beispiel:
```groovy
task compressFile(type: Gzip) {
dataFile = file("./planregister.xml");
gzipFile = file("./planregister.xml.gz");
}
```
### Ili2gpkgImport
Importiert Daten aus einer INTERLIS-Transferdatei in eine GeoPackage-Datei.
Die Tabellen werden implizit auch angelegt, falls sie noch nicht vorhanden sind. Falls die Tabellen in der Datenbank
schon vorhanden sind, können sie zusätzliche Spalten enthalten (z.B. bfsnr, datum etc.), welche beim Import leer bleiben.
Falls beim Import ein Datensatz-Identifikator (dataset) definiert wird, darf dieser Datensatz-Identifikator in der
Datenbank noch nicht vorhanden sein.
Um die bestehenden (früher importierten) Daten zu ersetzen, kann der Task Ili2gpkgReplace (**not yet implemented**) verwendet werden.
Die Option `--doSchemaImport` wird automatisch gesetzt.
Beispiel:
```groovy
task importData(type: Ili2gpkgImport) {
models = "SO_AGI_AV_GB_Administrative_Einteilungen_20180613"
dataFile = file("data.xtf");
dbfile = file("data.gpkg")
}
```
Parameter | Beschreibung
----------|-------------------
dbfile | GeoPackage-Datei in die importiert werden soll
dataFile | Name der XTF-/ITF-Datei, die gelesen werden soll. Es können auch mehrere Dateien sein.
proxy | Entspricht der ili2gpkg Option \--proxy
proxyPort | Entspricht der ili2gpkg-Option \--proxyPort
modeldir | Entspricht der ili2gpkg-Option \--modeldir
models | Entspricht der ili2gpkg-Option \--models
dataset | Entspricht der ili2gpkg-Option \--dataset
baskets | Entspricht der ili2gpkg-Option \--baskets
topics | Entspricht der ili2gpkg-Option \--topics
preScript | Entspricht der ili2gpkg-Option \--preScript
postScript | Entspricht der ili2gpkg-Option \--postScript
deleteData | Entspricht der ili2gpkg-Option \--deleteData
logFile | Entspricht der ili2gpkg-Option \--logFile
validConfigFile | Entspricht der ili2gpkg-Option \--validConfigFile
disableValidation | Entspricht der ili2gpkg-Option \--disableValidation
disableAreaValidation | Entspricht der ili2gpkg-Option \--disableAreaValidation
forceTypeValidation | Entspricht der ili2gpkg-Option \--forceTypeValidation
strokeArcs | Entspricht der ili2gpkg-Option \--strokeArcs
skipPolygonBuilding | Entspricht der ili2gpkg-Option \--skipPolygonBuilding
skipGeometryErrors | Entspricht der ili2gpkg-Option \--skipGeometryErrors
iligml20 | Entspricht der ili2gpkg-Option \--iligml20
coalesceJson | Entspricht der ili2gpkg-Option \--coalesceJson
nameByTopic | Entspricht der ili2gpkg-Option \--nameByTopic
defaultSrsCode | Entspricht der ili2gpkg-Option \--defaultSrsCode
createEnumTabs | Entspricht der ili2gpkg-Option \--createEnumTabs
createMetaInfo | Entspricht der ili2gpkg-Option \--createMetaInfo
Für die Beschreibung der einzenen ili2gpkg Optionen: https://github.com/claeis/ili2db/blob/master/docs/ili2db.rst#aufruf-syntax
### Ili2pgExport
Exportiert Daten aus der PostgreSQL-Datenbank in eine INTERLIS-Transferdatei.
Mit dem Parameter ``models``, ``topics``, ``baskets`` oder ``dataset`` wird definiert, welche Daten exportiert werden.
Ob die Daten im INTERLIS 1-, INTERLIS 2- oder GML-Format geschrieben werden, ergibt sich aus der Dateinamenserweiterung der Ausgabedatei. Für eine INTERLIS 1-Transferdatei muss die Erweiterung .itf verwendet werden. Für eine GML-Transferdatei muss die Erweiterung .gml verwendet werden.
Beispiel:
```groovy
def db_uri = 'jdbc:postgresql://localhost/gretldemo'
def db_user = "dmluser"
def db_pass = "dmluser"
task exportData(type: Ili2pgExport){
database = [db_uri, db_user, db_pass]
dataFile = "lv03_254900-out.itf"
dataset = "254900"
logFile = "ili2pg.log"
}
```
Damit mit einer einzigen Task-Definition mehrere Datensätze verarbeitet werden können, kann auch eine Liste von Dateinamen und Datensätzen angegeben werden.
```groovy
def db_uri = 'jdbc:postgresql://localhost/gretldemo'
def db_user = "dmluser"
def db_pass = "dmluser"
task exportData(type: Ili2pgExport){
database = [db_uri, db_user, db_pass]
dataFile = ["lv03_254900-out.itf","lv03_255000-out.itf"]
dataset = ["254900","255000"]
logFile = "ili2pg.log"
}
```
Parameter | Beschreibung
----------|-------------------
database | Datenbank aus der exportiert werden soll
dataFile | Name der XTF-/ITF-Datei, die erstellt werden soll
dbschema | Entspricht der ili2pg-Option \--dbschema
proxy | Entspricht der ili2pg-Option \--proxy
proxyPort | Entspricht der ili2pg-Option \--proxyPort
modeldir | Entspricht der ili2pg-Option \--modeldir
models | Entspricht der ili2pg-Option \--models
dataset | Entspricht der ili2pg-Option \--dataset
baskets | Entspricht der ili2pg-Option \--baskets
topics | Entspricht der ili2pg-Option \--topics
preScript | Entspricht der ili2pg-Option \--preScript
postScript | Entspricht der ili2pg-Option \--postScript
deleteData | Entspricht der ili2pg-Option \--deleteData
logFile | Entspricht der ili2pg-Option \--logFile
validConfigFile | Entspricht der ili2pg-Option \--validConfigFile
disableValidation | Entspricht der ili2pg-Option \--disableValidation
disableAreaValidation | Entspricht der ili2pg-Option \--disableAreaValidation
forceTypeValidation | Entspricht der ili2pg-Option \--forceTypeValidation
strokeArcs | Entspricht der ili2pg-Option \--strokeArcs
skipPolygonBuilding | Entspricht der ili2pg-Option \--skipPolygonBuilding
skipGeometryErrors | Entspricht der ili2pg-Option \--skipGeometryErrors
export3 | Entspricht der ili2pg-Option \--export3
iligml20 | Entspricht der ili2pg-Option \--iligml20
disableRounding | Entspricht der ili2pg-Option \--disableRounding
failOnException | Task wirft Exception, falls ili2db-Prozess fehlerhaft ist (= Ili2dbException). Default: true.
Für die Beschreibung der einzenen ili2pg-Optionen: [https://github.com/claeis/ili2db/blob/master/docs/ili2db.rst#aufruf-syntax](https://github.com/claeis/ili2db/blob/master/docs/ili2db.rst#aufruf-syntax)
### Ili2pgImport
Importiert Daten aus einer INTERLIS-Transferdatei in die PostgreSQL-Datenbank.
Die Tabellen werden implizit auch angelegt, falls sie noch nicht vorhanden sind. Falls die Tabellen in der Datenbank schon vorhanden sind, können sie zusätzliche Spalten enthalten (z.B. bfsnr, datum etc.), welche beim Import leer bleiben.
Falls beim Import ein Datensatz-Identifikator (dataset) definiert wird, darf dieser Datensatz-Identifikator in der Datenbank noch nicht vorhanden sein.
Falls man mehrere Dateien importieren will, diese jedoch erst zur Laufzeit eruiert werden können, muss der Parameter `dataFile` eine Gradle `FileCollection` resp. eine implementierende Klasse (z.B. `FileTree`) sein. Gleiches gilt für den `dataset`-Parameter. Als einzelner Wert für das Dataset wird in diesem Fall der Name der Datei _ohne_ Extension und _ohne_ Pfad verwendet. Leider kann nicht bereits in der Task-Definition aus dem Filetree eine Liste gemacht werden, z.B. `fileTree(pathToUnzipFolder) { include '*.itf' }.files.name`. Diese Liste ist leer.
Um die bestehenden (früher importierten) Daten zu ersetzen, kann der Task Ili2pgReplace verwendet werden.
Ili2pgImport unterstützt den Import von Daten in einem ilidata-Repository. Der Dateinamen (`dataFile`) entspricht dem Identifikator der Datei im Repository. Dem Identifikator muss `ilidata:` vorangestellt werden.
Beispiel 1:
```groovy
def db_uri = 'jdbc:postgresql://localhost/gretldemo'
def db_user = "dmluser"
def db_pass = "dmluser"
task importData(type: Ili2pgImport){
database = [db_uri, db_user, db_pass]
dataFile = "lv03_254900.itf"
logFile = "ili2pg.log"
}
```
Beispiel 2:
Import der AV-Daten. In der `t_datasetname`-Spalte soll die BFS-Nummer stehen. Die BFS-Nummer entspricht den ersten vier Zeichen des Filenamens.
```groovy
def db_uri = 'jdbc:postgresql://localhost/gretldemo'
def db_user = "dmluser"
def db_pass = "dmluser"
task importData(type: Ili2pgImport){
database = [db_uri, db_user, db_pass]
dataFile = fileTree(pathToUnzipFolder) { include '*.itf' }
dataset = dataFile
datasetSubstring = 0..4
logFile = "ili2pg.log"
}
```
Parameter | Beschreibung
----------|-------------------
database | Datenbank in die importiert werden soll
dataFile | Name der XTF-/ITF-Datei, die gelesen werden soll. Es können auch mehrere Dateien sein.
dbschema | Entspricht der ili2pg-Option \--dbschema
proxy | Entspricht der ili2pg-Option \--proxy
proxyPort | Entspricht der ili2pg-Option \--proxyPort
modeldir | Entspricht der ili2pg-Option \--modeldir
models | Entspricht der ili2pg-Option \--models
dataset | Entspricht der ili2pg-Option \--dataset
datasetSubstring | Range für das Extrahieren eines Substrings von Datasets
baskets | Entspricht der ili2pg-Option \--baskets
topics | Entspricht der ili2pg-Option \--topics
preScript | Entspricht der ili2pg-Option \--preScript
postScript | Entspricht der ili2pg-Option \--postScript
deleteData | Entspricht der ili2pg-Option \--deleteData
logFile | Entspricht der ili2pg-Option \--logFile
importTid | Entspricht der ili2pg-Option \--importTid
importBid | Entspricht der lii2pg Option --importBid
validConfigFile | Entspricht der ili2pg-Option \--validConfigFile
disableValidation | Entspricht der ili2pg-Option \--disableValidation
disableAreaValidation | Entspricht der ili2pg-Option \--disableAreaValidation
forceTypeValidation | Entspricht der ili2pg-Option \--forceTypeValidation
strokeArcs | Entspricht der ili2pg-Option \--strokeArcs
skipPolygonBuilding | Entspricht der ili2pg-Option \--skipPolygonBuilding
skipGeometryErrors | Entspricht der ili2pg-Option \--skipGeometryErrors
iligml20 | Entspricht der ili2pg-Option \--iligml20
disableRounding | Entspricht der ili2pg-Option \--disableRounding
failOnException | Task wirft Exception, falls ili2db-Prozess fehlerhaft ist (= Ili2dbException). Default: true.
Für die Beschreibung der einzenen ili2pg-Optionen: [https://github.com/claeis/ili2db/blob/master/docs/ili2db.rst#aufruf-syntax](https://github.com/claeis/ili2db/blob/master/docs/ili2db.rst#aufruf-syntax)
### Ili2pgImportSchema
Erstellt die Tabellenstruktur in der PostgreSQL-Datenbank anhand eines INTERLIS-Modells.
Der Parameter ``iliFile`` oder ``models`` muss gesetzt werden.
Beispiel:
```groovy
def db_uri = 'jdbc:postgresql://localhost/gretldemo'
def db_user = "dmluser"
def db_pass = "dmluser"
task importSchema(type: Ili2pgImportSchema){
database = [db_uri, db_user, db_pass]
models = "DM01AVSO24"
dbschema = "gretldemo"