Oracle Graph je výkonný nástroj navržený k odhalování skrytých vztahů ve vašich datech. Reprezentací informací ve struktuře grafu umožňuje Oracle Graph organizacím získat cenné poznatky z propojených datových entit. Nabídka Oracle Graph zahrnuje Graph Server REST API, bránu pro využití možností Oracle Graph z libovolné aplikace pomocí jednoduchého volání REST. Toto rozhraní API umožňuje vývojářům interagovat s jejich grafy, umožňuje jim vytvářet grafy, spouštět dotazy a odvozovat z dat informace, které lze použít.
Oracle Graph REST API v1 využívá ověřování založené na souborech cookie a kóduje dotazy v adresách URL. Ve verzi Oracle Graph Server and Client 23.3 jsme vydali Oracle Graph REST API v2, které využívá autentizaci založenou na tokenech a umožňuje přenos dotazů v těle JSON. Graph Server REST API poskytuje vývojářům životně důležitý zdroj pro snadné vytváření a dotazování na grafy.
Pozadí pro následující příklady:
- Oracle Graph zahrnuje schopnost spouštět dotazy na grafy v databázi Oracle a také spouštět dotazy na grafy a analýzy na specializovaném grafickém serveru v paměti (PGX).
- Chcete-li načíst data z příkladu bank_graph a vytvořit graf, podívejte se na toto úložiště github.
Graph Server REST API v2
Pojďme si projít jednoduchý příklad pomocí verze 2 rozhraní Graph Server REST API s Postmanem. U všech následujících volání API se ujistěte, že požadavek má následující záhlaví:
- Přijmout: application/json; znaková sada=UTF-8
- Content-Type: application/json
1. Získejte ověřovací token
Vytvořte požadavek POST na https://<IP_Graph_Server_IP>:7007/auth/token . Přidejte tělo JSON s uživatelským jménem, heslem a parametry createSession.
Nastavte parametr createSession na hodnotu True, pokud chcete vytvořit relaci PGX pro spouštění dotazů na Graph Server v paměti, nebo na hodnotu False, pokud spouštíte dotazy v databázi.
Odpovědí by měl být přístupový token, který použijeme v dalších voláních API.
2. Získejte grafy
Vytvořte požadavek GET na https:// <Graph_Server_IP>:7007/v2/graphs s parametrem dotazu pro ovladač, který chcete použít (GRAPH_SERVER_PGX, PGQL_IN_DATABASE nebo SQL_IN_DATABASE). Výsledný řetězec dotazu by měl vypadat takto https:// <IP_Graph_Server_IP>:7007/v2/graphs?driver=pgql_in_database .
Přidejte záhlaví Authorization s hodnotou ‚ Bearer <access_token> ‚.
Odpovědí by měl být seznam grafů pro vašeho ověřeného uživatele.
3. Spusťte dotaz
Vytvořte požadavek POST na https:// <IP_Graph_Server_IP>:7007/v2/runQuery .
Přidejte záhlaví Authorization s hodnotou ‚ Bearer <access_token> ‚.
Přidejte tělo JSON s příkazy, ovladačem, formátovačem, parametry a parametry vizualizace podle tohoto příkladu:
„výkazy“: [
„SELECT v FROM MATCH (v) ON BANK_GRAPH LIMIT 1“
],
„driver“: „PGQL_IN_DATABASE“,
„formatter“: „GVT“,
„parameters“: {
„dynamicSampling“: 2,
„paralelní „: 8,
„start“: 0,
„size“: 100
},
„vizualizovat“: true
}
Výsledkem by měl být objekt JSON s výsledkem běhu dotazu.
4. Obnovte přístupový token
Chcete-li obnovit svůj přístupový token před vypršením jeho platnosti, vytvořte požadavek PUT na https://<IP_Graph_Server_IP>:7007/auth/token .
Přidejte tělo JSON s tokenem a parametry createSession. Token by měl mít hodnotu aktuálního přístupového tokenu. Nastavte parametr createSession na hodnotu True, pokud chcete vytvořit relaci PGX pro spouštění dotazů na Graph Server v paměti, nebo na hodnotu False, pokud spouštíte dotazy v databázi.
Odpovědí by měl být nový přístupový token.
Další informace o v2 rozhraní Graph Server REST API a úplný seznam funkcí naleznete v oficiální dokumentaci.
Graph Server REST API v1
Pojďme si projít jednoduchý příklad pomocí verze 1 rozhraní Graph Server REST API s Postmanem. U všech následujících volání API se ujistěte, že požadavek má následující záhlaví:
- Přijmout: application/json; znaková sada=UTF-8
- Content-Type: application/json
1. Ověřte uživatele
Vytvořte požadavek POST na https://<IP_Graph_Server_IP>:7007/ui/v1/login/ .
Přidejte tělo JSON s uživatelským jménem, heslem, parametry pgqlDriver a baseUrl. Parametr pgqlDriver určuje, zda se chcete připojit k databázi pomocí pgqlDriver nebo ke Graph Serveru pomocí pgxDriver. Parametr baseUrl by měla být adresa URL serveru Graph Server, pokud používáte pgxDriver, nebo adresa URL JDBC pro vaši databázi, pokud používáte pgqlDriver.
Odpovědí by mělo být uživatelské jméno uživatele, který byl ověřen. Po úspěšném přihlášení se soubor cookie relace serveru uloží do souboru cookie, cookie.txt.
2. Seznam grafů
Vytvořte požadavek GET na https://<IP_Graph_Server_IP>:7007/ui/v1/graphs . Soubor cookie by měl být automaticky přidán jako záhlaví v Postman.
Odpovědí by měl být seznam grafů pro vašeho ověřeného uživatele.
3. Spusťte dotaz
Vytvořte požadavek Get na https://<IP_Graph_Server_IP>:7007/ui/v1/query s parametry pgql, graf, paralelismus a velikost. Výsledná adresa URL by měla vypadat takto:
https://<IP_Graph_Server_IP>:7007/ui/v1/query?pgql=<PGQL_query>&graph=<název_grafu>¶llelism= <value_parallelism>&size=<velikost>
Například k dotazu na pět hran z bank_graph můžeme použít následující: https://<IP_Server_Graph>:7007/ui/v1/query?pgql=SELECT%20e%0AMATCH%20()-%5Be%5D-%3E ()%0ALIMIT%205&graph=BANK_GRAPH¶llelism=&size=100
Výsledek by měl zahrnovat výsledné vrcholy a hrany dotazované ve formátu JSON.
4. Odhlášení z Graph Serveru
Vytvořte požadavek POST na https://<IP_Graph_Server_IP>:7007/ui/v1/logout/ .
Po úspěšném odhlášení by měl server vrátit stavový kód HTTP 200 a token relace ze souboru cookie.txt již nebude platný.
Další informace o v1 rozhraní Graph Server REST API a úplný seznam funkcí naleznete v oficiální dokumentaci.
Zdroj: Oracle
