Zahteve za storitev OData

Gonilnik deluje z vsako storitvijo OData v4, ki podpira spodaj navedene obvezne lastnosti. Če storitev dodatno podpira katero od razširitev, jo gonilnik uporabi; brez nje se vede, kot da je ni. To stran potrebujete, ko preverjate, ali storitev deluje skupaj z gonilnikom, ali ko sami gradite storitev za aplikacije Access. Podatkovni prehod Wkl.Data.Gateway podpira vse lastnosti, navedene na tej strani.

GET  <koren-storitve>/$metadata                       dokument metapodatkov (CSDL, XML)
GET  <koren-storitve>/<množica>?$select=…&$filter=…     branje, odgovor JSON
POST/PATCH/DELETE <koren-storitve>/<množica>[(<ključ>)]   pisanje

Lastnosti so razvrščene po tem, kako nujne so za gonilnik: brez obveznega za branje se gonilnik ne poveže ali bere napačno; brez obveznega za pisanje ostanejo vse množice samo za branje; razširitve so priporočila: brez njih posamezna funkcija ni na voljo, nič pa ne deluje napačno. Osnove OData v4 opisujejo standardi OASIS: OData Version 4.01 Part 1: Protocol, Part 2: URL Conventions (poizvedbene možnosti, literali), OData Common Schema Definition Language (CSDL) XML Representation 4.01 ($metadata) in OData JSON Format 4.01. Gonilnik zahteva samo lastnosti, ki jih pozna že OData 4.0; $query (4.01) uporabi, če obstaja.

Obvezno za branje

Obvezno za pisanje

Razširitve (priporočene), ki jih gonilnik uporabi, če jih storitev podpira

Izrazi besednjaka Wkl.Store.V1. Besednjak je razširitev tega izdelka, ni del OData. Storitev, ki ga podpira, ga objavi pod lastnim naslovom in ga vključi z edmx:Reference (primer spodaj); gonilnik izraze prepozna po imenskem prostoru, z aliasom ali brez.

Katera zaveza gonilnika velja, je odvisno od tega, kaj storitev podpira in upošteva. Gonilnik prepozna deklaracije v $metadata, ne pa tega, ali storitev glavo, kot je Idempotency-Key, dejansko upošteva. Česar ne more prepoznati, morate pred uporabo razjasniti s ponudnikom storitve ali preveriti sami.

Kaj mora storitev zagotoviti za ponovitev. Gonilnik spremembo ponovi največ dvakrat, po 1 in po 3 sekundah, z istim Idempotency-Key. Storitev mora zato prvi odgovor h ključu hraniti vsaj nekaj sekund in na ponovitev vrniti natanko ta odgovor, ne da bi spremembo izvedla še enkrat. Prekoračene časovne omejitve (HYT00) gonilnik ne ponovi: v tem primeru ni znano, ali je bila sprememba izvedena, zato mora aplikacija zapis znova prebrati. Zaključka transakcije (commit, rollback) prav tako ne ponovi.

Kaj mora storitev zagotoviti iz varnostnih razlogov. Zahtevo brez veljavne prijave ali 2FA zavrne, preden karkoli izvede; gonilnik jo nato pošlje znova. Poleg tega naslovov pod korenom storitve ne sme preusmerjati na drug izvor (glejte Preostala tveganja).

Nobena. Gonilnik lastnosti preverja ob povezovanju in ob posamezni uporabi, ne vnaprej.

• Brez Core.OptimisticConcurrency Access pri spreminjanju v pogoj postavi stare vrednosti vseh stolpcev. Tega v OData ni mogoče izraziti; gonilnik to zavrne, namesto da bi preverjanje opustil. Rešitev zagotovi storitev, na primer z izračunano lastnostjo sočasnosti.
• Brez združevanja v skupine in brez naslova za lastne stavke poizvedbe z vsotami in spoji iz Accessa ne uspejo z “ODBC–call failed”; glejte Odpravljanje težav.
• Brez podpore za Idempotency-Key lahko ponovitev po prekinitvi povezave zapis ustvari dvakrat ali javi konflikt pri pisanju, čeprav je sprememba uspela. Storitev, ki glave ne pozna, jo prezre; gonilnik tega ne prepozna. Glavo opisuje potekel osnutek IETF, ne standard (glejte Standardi in specifikacije).
• Oblika lastnih stavkov pri prenosu. Gonilnik pošlje {"sql": …, "parameters": {…}} in pričakuje {"columns": […], "data": […], "affectedRowCount": …}. Vezane vrednosti ostanejo vrednosti: označbe mest ?, ki jih ODBC šteje po položaju, postanejo poimenovane označbe – vprašaj v nizu, v imenu v oklepajih ali v komentarju pri tem ostane nedotaknjen. Odgovor brez columns se zavrne. Sklepanje o tipih iz vrednosti prve vrstice bi pomenilo: celo število v decimalnem stolpcu postane celo število, časovna točka postane besedilo, prazen rezultat pa sploh nima oblike – medtem ko aplikacija svoje medpomnilnike veže, preden prebere prvo vrstico.
• Izhodni parametri, nadaljnji nizi rezultatov, opis. Če aplikacija veže izhodne parametre, gonilnik pošlje še "outputs": {"p1": "Edm.Int32", "p2": {"type": "Edm.String", "maxLength": 20}} in vrednosti prebere iz outputs v odgovoru; nadaljnje nize rezultatov prebere iz results (vsak z columns, data, truncated). Če aplikacija pred izvedbo vpraša po stolpcih, gonilnik pošlje "describe": true in pričakuje stolpce prvega niza, ne da bi storitev kaj izvedla. Opis zahteva samo od storitve, ki naslov sama navede v Store.PassThrough: storitev, ki describe prezre, bi stavek sicer izvedla. Če storitev ne vrne outputs, aplikacija kot izhodno vrednost dobi NULL.
• Opis stolpcev. Poleg name, type in faset (maxLength, precision, scale) gonilnik za vsak stolpec prebere tri neobvezne podatke: storeType (ime tipa v podatkovni zbirki, kot Store.Type v $metadata), identity (true za vrednost, ki jo dodeli podatkovna zbirka) in label (ime, ki ga stolpcu da podatkovna zbirka, kjer se razlikuje od name). Vrstice so predmeti JSON; za stolpec brez imena ali z že uporabljenim imenom mora storitev zato določiti lasten ključ. Z label gonilnik aplikaciji pokaže ime podatkovne zbirke – prazno ali ponovljeno, kot ODBC Driver 18 – vrednosti pa bere pod name. Brez label aplikacija vidi ta ključ.
• Store.PassThrough velja samo na istem izvoru (shema, računalnik, vrata) kot koren storitve.
• Polja odgovora, ki jih gonilnik ne pozna, preskoči. Na prepustni poti bere columns, data, affectedRowCount, truncated, results in outputs (glejte Omejitve).
• Brez preusmeritve na drug izvor. Gonilnik preusmeritvi sledi samo pri branju in samo pri isti shemi, računalniku in vratih; če storitev preusmeri drugam, se zahteva konča z napako 08S01.

Izsek dokumenta metapodatkov z razširitvami, ki jih Access potrebuje za urejanje in združevanje v skupine:

<edmx:Reference Uri="https://oasis-tcs.github.io/odata-vocabularies/vocabularies/Org.OData.Aggregation.V1.xml">
  <edmx:Include Namespace="Org.OData.Aggregation.V1" Alias="Aggregation" />
</edmx:Reference>
<edmx:Reference Uri="https://daten.example.com/odata/v4/$vocabulary/Wkl.Store.V1.xml">
  <edmx:Include Namespace="Wkl.Store.V1" Alias="Store" />
</edmx:Reference>
…
<EntityContainer Name="Container">
  <Annotation Term="Store.Product" String="Microsoft SQL Server" />
  <Annotation Term="Store.ProductVersion" String="17.00" />
  <Annotation Term="Store.Schema" String="dbo" />
  <Annotation Term="Aggregation.ApplySupported">
    <Record>
      <PropertyValue Property="Transformations">
        <Collection><String>filter</String><String>compute</String><String>groupby</String><String>aggregate</String></Collection>
      </PropertyValue>
      <PropertyValue Property="Rollup" EnumMember="Aggregation.RollupType/None" />
    </Record>
  </Annotation>
  <Annotation Term="Aggregation.CustomAggregationMethods">
    <Collection><String>Wkl.Store.V1.count</String></Collection>
  </Annotation>
</EntityContainer>

Tako ga vrne podatkovni prehod (skrajšano). Izrazi so zapisani z aliasom, ki ga dodeli edmx:Reference; gonilnik bere oba zapisa.

Gonilnik Wkl OData v 32- in 64-bitni različici. OData v2 in v3 ter storitve brez $metadata ali brez JSON niso podprte.

• Kako gonilnik prevaja stavke
• Niz povezave gonilnika