Lastnosti povezave ponudnika

Ponudnik opiše nastavitve svoje povezave kot posamezne lastnosti. Program za upravljanje zanje prikaže vnosna polja namesto prostega besedilnega polja za niz povezave. Niz povezave sestavi in preveri ponudnik sam.

Sintaksa

Branje opisa:

GET /admin/v1/odata/Providers?$filter=Usable eq true and Latest eq true
GET /admin/v1/odata/ProviderProperties?$filter=Provider eq 'sqlserver' and Language eq 'sl'&$orderby=Scope,Position

Ustvarjanje vira podatkov iz lastnosti; ConnectionProperties je objekt JSON kot besedilo:

POST /admin/v1/odata/DataSources
Content-Type: application/json
 
{ "Name": "fachdaten", "Provider": "sqlserver",
  "ConnectionProperties": "{\"Data Source\":\"srv01\",\"Initial Catalog\":\"Fachdaten\",\"Integrated Security\":\"true\"}" }

Pri branju DataSources vrne enako obliko, brez skrivnih vrednosti:

{ "Name": "fachdaten", "Provider": "sqlserver", "Connection": null,
  "ConnectionProperties": "{\"Data Source\":\"srv01\",\"Initial Catalog\":\"Fachdaten\",\"Integrated Security\":\"true\"}" }

Parametri

Množica Providers

Samo za branje. Ena vrstica za vsak nameščen paket ponudnika, uporaben ali ne.

Polje	Vsebina
`Id`, `PackageVersion`	Ključ: oznaka ponudnika (`sqlserver`) in različica paketa
`Name`, `Vendor`	Prikazno ime in proizvajalec po navedbi paketa
`Aliases`	Druga imena, ločena z vejico (samo priloženi paketi, npr. `mssql`)
`ContractMin`, `ContractBelow`	Razpon specifikacije vmesnika ponudnika, za katerega je paket zgrajen
`BuiltIn`	Priložen prehodu (`true`) ali ste ga namestili sami
`Usable`, `Problem`	Ali paket opravi preverjanja; sicer razlog
`Latest`	Najvišja uporabna različica te oznake: različica, ki jo dobi vir podatkov brez `ProviderVersion`
`DescribesConnection`	Ali ponudnik opiše lastnosti svoje povezave; sicer ostane le niz (`Connection`)

Množica ProviderProperties

Samo za branje. Za vsak uporaben paket, ki opiše svojo povezavo: ena vrstica za vsako lastnost, področje in jezik.

Polje	Vsebina
`Provider`, `PackageVersion`, `Scope`, `Name`, `Language`	Ključ. `Scope`: `Connection` (povezava) ali `Options` (nastavitve ponudnika, `ProviderOptions`). `Language`: dvočrkovna oznaka; vsaka lastnost obstaja vsaj v `en`
`Position`	Vrstni red znotraj področja, od 1
`Type`	`Text`, `Integer` (samo števke), `Boolean` (`true`/`false`) ali `Choice`
`Label`, `Description`	Oznaka in pojasnilo v tem jeziku; angleško, če ponudnik jezika nima
`Required`	Ali povezava vrednost potrebuje
`Default`	Vrednost, ki velja brez navedbe, kot besedilo; prazno, če nobena ne velja
`Choices`	Pri `Choice`: dovoljene vrednosti kot seznam JSON, npr. `["True","False","Strict"]`
`Secret`	Skrivnost (geslo): vrednost se lahko zapiše, nikoli pa ne vrne
`Category`	Skupina za prikaz, npr. `Server`, `Security`, `Advanced`

Branje ProviderProperties naloži vsak uporaben paket, ki še ni naložen: opis je koda ponudnika.

Polja množice DataSources

Polje	Pomen
`Provider`	Oznaka ponudnika; prazno: velja `Dialect`
`ProviderVersion`	Fiksna različica paketa; prazno: najvišja uporabna
`ProviderOptions`	Nastavitve ponudnika kot objekt JSON iz besedil, npr. `{"Modus":"schnell"}`; prazno, če ponudnik nobene ne pozna
`Connection`	Niz povezave kot besedilo; samo za pisanje, bere se prazno
`ConnectionProperties`	Povezava kot objekt JSON iz lastnosti in vrednosti, kot besedilo. Zapisano: ponudnik iz tega sestavi niz. Prebrano: lastnosti shranjene povezave brez skrivnih vrednosti

Provider, ProviderVersion in ProviderOptions pomenijo isto kot v datoteki, glejte konfiguracijo.

Lastnosti ponudnika sqlserver

Priloženi ponudnik za SQL Server opiše te lastnosti; ProviderOptions ne pozna nobenih. Imena so ključne besede, ki jih gonilnik za SQL Server zapiše v niz. Privzete in dovoljene vrednosti izhajajo iz gonilnika samega; merodajna je ProviderProperties.

Ime	Tip	Kategorija	Obvezno	Pomen
`Data Source`	Text	Server	da	Strežnik, z instanco (`srv01\prod`) ali vrati (`srv01,1433`)
`Initial Catalog`	Text	Server	da	Podatkovna zbirka, ki jo prehod ponuja pod aliasom
`Failover Partner`	Text	Server		Zrcalni strežnik pri zrcaljenju podatkovne zbirke
`Multi Subnet Failover`	Boolean	Server		Skupina razpoložljivosti prek več podomrežij
`Application Intent`	Choice	Server		`ReadWrite` (privzeto) ali `ReadOnly` (bralna replika)
`Integrated Security`	Boolean	Security		Prijava Windows z računom storitve
`Authentication`	Choice	Security		Postopek za Microsoft Entra ID, npr. `ActiveDirectoryIntegrated`; prazno za prijavo SQL ali prijavo Windows
`User ID`	Text	Security		Prijava SQL
`Password`	Text	Security		Geslo prijave SQL; skrivno
`Encrypt`	Choice	Security		`True` (privzeto), `False` ali `Strict`
`Trust Server Certificate`	Boolean	Security		Sprejmi potrdilo strežnika brez preverjanja; samo za testna okolja
`Host Name In Certificate`	Text	Security		Pričakovano ime v potrdilu
`Application Name`	Text	Advanced		Ime povezave na strežniku; brez navedbe `Wkl.Data.Gateway`
`Connect Timeout`	Integer	Advanced		Sekunde do prekinitve vzpostavljanja povezave (privzeto 15)
`Command Timeout`	Integer	Advanced		Privzeto v sekundah za ukaze; omejitve prehoda imajo prednost

Ni ponujenih nastavitev, ki jih prehod vodi sam (Pooling, velikosti bazena, MultipleActiveResultSets). Ročno zapisan niz jih sme vsebovati; kot lastnosti se tedaj ne pojavijo.

Opombe

Kdo sestavi niz. Ponudnik vira podatkov – Provider, sicer Dialect – iz lastnosti sestavi niz in ga preveri. Program za upravljanje ne potrebuje znanja o ključnih besedah podatkovne zbirke. Prehod ta niz zapečati enako kot niz, poslan kot besedilo.

Pisanje. Connection in ConnectionProperties hkrati prehod zavrne z 400, prav tako ponudnika brez opisa (DescribesConnection = false). Vrednosti so lahko nizi, števila ali true/false JSON; null ali prazen niz lastnost odstrani. Neznana lastnost, manjkajoča obvezna vrednost ali vrednost napačnega tipa vrne 400; sporočilo navede lastnost, nikoli njene vrednosti.

Geslo pri spreminjanju. Če skrivna lastnost v ConnectionProperties manjka, prehod obdrži njeno shranjeno vrednost: kdor spremeni le strežnik, gesla ne vnese znova. Izrecno prazna vrednost ("Password": "") ga odstrani. Vse druge lastnosti nadomestijo shranjeno povezavo v celoti; kar manjka, nato velja s privzeto vrednostjo.

Branje. ConnectionProperties vsebuje nastavljene lastnosti shranjene povezave, nikoli skrivne. Polje ostane prazno, če ponudnik nima opisa ali ročno zapisanega niza ne more razstaviti; povezavo lahko tedaj spremenite prek Connection. Polje ni del različice vrstice; različica sledi zapečatenemu nizu.

Dnevnik sprememb. ConnectionProperties se tam pojavi le kot „neu gesetzt“ (na novo nastavljen), tako kot Connection.

Primer

Program za upravljanje napolni izbiro ponudnikov in mrežo lastnosti:

Preberite Providers z Usable eq true and Latest eq true in napolnite izbiro (Name, vrednost Id).
Za izbrani Id preberite ProviderProperties z Scope eq 'Connection' in jezikom programa, razvrstite po Position, združite po Category; Choice kot izbira, Boolean kot stikalo, Secret kot polje za geslo.
Pri urejanju preberite ConnectionProperties vira podatkov in vnaprej izpolnite polja; polje za geslo ostane prazno.
Shranjevanje: v ConnectionProperties pošljite kot objekt JSON samo izpolnjena polja, praznega polja za geslo ne – shranjeno geslo tedaj ostane.
Preverite s `test-connection`.