API Kueri Neptunus - Amazon Neptune
ExecuteGremlinQueryExecuteGremlinExplainQueryExecuteGremlinProfileQueryListGremlinQueriesGetGremlinQueryStatusCancelGremlinQuery________________________ExecuteOpenCypherQueryExecuteOpenCypherExplainQueryListOpenCypherQueriesGetOpenCypherQueryStatusCancelOpenCypherQuery________________________QueryEvalStatsGremlinQueryStatusGremlinQueryStatusAttributes

Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.

API Kueri Neptunus

Tindakan kueri Gremlin:

Tindakan kueri OpenCypher:

Struktur kueri:

ExecuteGremlinQuery (tindakan)

        Nama AWS CLI untuk API ini adalah:. execute-gremlin-query

Perintah ini mengeksekusi query Gremlin. Amazon Neptunus kompatibel dengan TinkerPop Apache 3 dan Gremlin, sehingga Anda dapat menggunakan bahasa traversal Gremlin untuk menanyakan grafik, seperti yang dijelaskan di bawah Grafik dalam dokumentasi Apache 3. TinkerPop Rincian lebih lanjut juga dapat ditemukan di Mengakses grafik Neptunus dengan Gremlin.

Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan salah satu tindakan IAM berikut di cluster itu, tergantung pada kueri:

Perhatikan bahwa kunci kondisi QueryLanguageIAM neptune-db ::Gremlin dapat digunakan dalam dokumen kebijakan untuk membatasi penggunaan kueri Gremlin (lihat Kunci kondisi yang tersedia di pernyataan kebijakan akses data IAM Neptunus).

Permintaan

  • gremlinQuery(dalam CLI:--gremlin-query) - Diperlukan: String, tipe: string (string yang dikodekan UTF-8).

    Dengan menggunakan API ini, Anda dapat menjalankan kueri Gremlin dalam format string sebanyak yang Anda bisa menggunakan endpoint HTTP. Antarmuka kompatibel dengan versi Gremlin apa pun yang digunakan cluster DB Anda (lihat bagian klien Tinkerpop untuk menentukan Gremlin mana yang merilis versi mesin Anda yang didukung).

  • serializer(dalam CLI:--serializer) — String, tipe: string (string yang dikodekan UTF-8).

    Jika non-null, hasil query dikembalikan dalam pesan respon serial dalam format yang ditentukan oleh parameter ini. Lihat bagian GraphSon dalam TinkerPop dokumentasi untuk daftar format yang saat ini didukung.

Respons

  • meta— Dokumen, tipe: document (konten terbuka protokol-agnostik yang diwakili oleh model data seperti JSON).

    Metadata tentang kueri Gremlin.

  • requestId— String, tipe: string (string yang dikodekan UTF-8).

    Pengidentifikasi unik dari kueri Gremlin.

  • result— Dokumen, tipe: document (konten terbuka protokol-agnostik yang diwakili oleh model data seperti JSON).

    Output query Gremlin dari server.

  • status — Sebuah objek GremlinQueryStatusAttributes.

    Status kueri Gremlin.

Galat

ExecuteGremlinExplainQuery (tindakan)

        Nama AWS CLI untuk API ini adalah:. execute-gremlin-explain-query

Mengeksekusi kueri Gremlin Expline.

Amazon Neptunus telah menambahkan fitur Gremlin explain bernama yang menyediakan alat swalayan untuk memahami pendekatan eksekusi yang diambil oleh mesin Neptunus untuk kueri. Anda memintanya dengan menambahkan parameter explain ke panggilan HTTP yang mengirimkan kueri Gremlin.

Fitur menjelaskan memberikan informasi tentang struktur logis dari rencana eksekusi kueri. Anda dapat menggunakan informasi ini untuk mengidentifikasi potensi kemacetan evaluasi dan eksekusi dan untuk menyetel kueri Anda, seperti yang dijelaskan dalam kueri Tuning Gremlin. Anda juga dapat menggunakan petunjuk kueri untuk meningkatkan rencana eksekusi kueri.

Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan otentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan salah satu tindakan IAM berikut di cluster itu, tergantung pada kueri:

Perhatikan bahwa kunci kondisi QueryLanguageIAM neptune-db ::Gremlin dapat digunakan dalam dokumen kebijakan untuk membatasi penggunaan kueri Gremlin (lihat Kunci kondisi yang tersedia di pernyataan kebijakan akses data IAM Neptunus).

Permintaan

  • gremlinQuery(dalam CLI:--gremlin-query) - Diperlukan: String, tipe: string (string yang dikodekan UTF-8).

    Gremlin menjelaskan string kueri.

Respons

  • output— a ReportAsText, tipe: blob (blok data biner yang tidak ditafsirkan).

    Gumpalan teks yang berisi Gremlin menjelaskan hasil, seperti yang dijelaskan dalam kueri Tuning Gremlin.

Galat

ExecuteGremlinProfileQuery (tindakan)

        Nama AWS CLI untuk API ini adalah:. execute-gremlin-profile-query

Mengeksekusi kueri Profil Gremlin, yang menjalankan traversal tertentu, mengumpulkan berbagai metrik tentang proses, dan menghasilkan laporan profil sebagai output. Lihat API profil Gremlin di Neptunus untuk detailnya.

Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM di cluster itu. ReadDataViaQuery

Perhatikan bahwa kunci kondisi QueryLanguageIAM neptune-db ::Gremlin dapat digunakan dalam dokumen kebijakan untuk membatasi penggunaan kueri Gremlin (lihat Kunci kondisi yang tersedia di pernyataan kebijakan akses data IAM Neptunus).

Permintaan

  • chop(dalam CLI:--chop) — Integer, tipe: integer (integer 32-bit yang ditandatangani).

    Jika non-nol, menyebabkan hasil string akan dipotong pada jumlah karakter tersebut. Jika diatur ke nol, string berisi semua hasil.

  • gremlinQuery(dalam CLI:--gremlin-query) - Diperlukan: String, tipe: string (string yang dikodekan UTF-8).

    String kueri Gremlin ke profil.

  • indexOps(dalam CLI:--index-ops) — Boolean, dari tipe: boolean (nilai Boolean (benar atau salah)).

    Jika tanda ini disetel keTRUE, hasilnya menyertakan laporan terperinci dari semua operasi indeks yang terjadi selama eksekusi kueri dan serialisasi.

  • results(dalam CLI:--results) — Boolean, dari tipe: boolean (nilai Boolean (benar atau salah)).

    Jika tanda ini disetel keTRUE, hasil kueri dikumpulkan dan ditampilkan sebagai bagian dari laporan profil. JikaFALSE, hanya jumlah hasil yang ditampilkan.

  • serializer(dalam CLI:--serializer) — String, tipe: string (string yang dikodekan UTF-8).

    Jika non-null, hasil yang dikumpulkan dikembalikan dalam pesan respons serial dalam format yang ditentukan oleh parameter ini. Lihat API profil Gremlin di Neptunus untuk informasi selengkapnya.

Respons

  • output— a ReportAsText, tipe: blob (blok data biner yang tidak ditafsirkan).

    Gumpalan teks yang berisi hasil Profil Gremlin. Lihat API profil Gremlin di Neptunus untuk detailnya.

Galat

ListGremlinQueries (tindakan)

        Nama AWS CLI untuk API ini adalah:. list-gremlin-queries

Daftar kueri Gremlin aktif. Lihat API status kueri Gremlin untuk detail tentang output.

Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM di cluster itu. GetQueryStatus

Perhatikan bahwa kunci kondisi QueryLanguageIAM neptune-db ::Gremlin dapat digunakan dalam dokumen kebijakan untuk membatasi penggunaan kueri Gremlin (lihat Kunci kondisi yang tersedia di pernyataan kebijakan akses data IAM Neptunus).

Permintaan

  • includeWaiting(dalam CLI:--include-waiting) — Boolean, dari tipe: boolean (nilai Boolean (benar atau salah)).

    Jika disetel keTRUE, daftar yang dikembalikan menyertakan kueri tunggu. Defaultnya adalahFALSE;

Respons

  • acceptedQueryCount— Integer, tipe: integer (integer 32-bit yang ditandatangani).

    Jumlah kueri yang telah diterima tetapi belum selesai, termasuk kueri dalam antrian.

  • queries – Susunan objek GremlinQueryStatus.

    Daftar kueri saat ini.

  • runningQueryCount— Integer, tipe: integer (integer 32-bit yang ditandatangani).

    Jumlah kueri Gremlin yang sedang berjalan.

Galat

GetGremlinQueryStatus (tindakan)

        Nama AWS CLI untuk API ini adalah:. get-gremlin-query-status

Mendapat status query Gremlin tertentu.

Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM di cluster itu. GetQueryStatus

Perhatikan bahwa kunci kondisi QueryLanguageIAM neptune-db ::Gremlin dapat digunakan dalam dokumen kebijakan untuk membatasi penggunaan kueri Gremlin (lihat Kunci kondisi yang tersedia di pernyataan kebijakan akses data IAM Neptunus).

Permintaan

  • queryId(dalam CLI:--query-id) - Diperlukan: String, tipe: string (string yang dikodekan UTF-8).

    Pengidentifikasi unik yang mengidentifikasi kueri Gremlin.

Respons

  • queryEvalStats — Sebuah objek QueryEvalStats.

    Status evaluasi kueri Gremlin.

  • queryId— String, tipe: string (string yang dikodekan UTF-8).

    ID kueri yang statusnya dikembalikan.

  • queryString— String, tipe: string (string yang dikodekan UTF-8).

    String kueri Gremlin.

Galat

CancelGremlinQuery (tindakan)

        Nama AWS CLI untuk API ini adalah:. cancel-gremlin-query

Membatalkan kueri Gremlin. Lihat pembatalan kueri Gremlin untuk informasi selengkapnya.

Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM di cluster itu. CancelQuery

Permintaan

  • queryId(dalam CLI:--query-id) - Diperlukan: String, tipe: string (string yang dikodekan UTF-8).

    Pengidentifikasi unik yang mengidentifikasi kueri yang akan dibatalkan.

Respons

  • status— String, tipe: string (string yang dikodekan UTF-8).

    Status pembatalan

Galat

Tindakan kueri OpenCypher:

ExecuteOpenCypherQuery (tindakan)

        Nama AWS CLI untuk API ini adalah:. execute-open-cypher-query

Mengeksekusi query OpenCypher. Lihat Mengakses Grafik Neptunus dengan OpenCypher untuk informasi lebih lanjut.

Neptunus mendukung pembuatan aplikasi grafik menggunakan OpenCypher, yang saat ini merupakan salah satu bahasa kueri paling populer di kalangan pengembang yang bekerja dengan database grafik. Pengembang, analis bisnis, dan ilmuwan data menyukai sintaks deklaratif dan terinspirasi SQL OpenCypher karena menyediakan struktur yang akrab untuk menanyakan grafik properti.

Bahasa OpenCypher awalnya dikembangkan oleh Neo4j, kemudian bersumber terbuka pada tahun 2015 dan berkontribusi pada proyek OpenCypher di bawah lisensi open-source Apache 2.

Perhatikan bahwa saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan salah satu tindakan IAM berikut di klaster tersebut, tergantung pada kueri:

Perhatikan juga bahwa kunci kondisi OpenCypher IAM neptune-db:QueryLanguage: dapat digunakan dalam dokumen kebijakan untuk membatasi penggunaan kueri OpenCypher (lihat Kunci kondisi yang tersedia dalam pernyataan kebijakan akses data IAM Neptunus).

Permintaan

  • openCypherQuery(dalam CLI:--open-cypher-query) - Diperlukan: String, tipe: string (string yang dikodekan UTF-8).

    String query OpenCypher yang akan dieksekusi.

  • parameters(dalam CLI:--parameters) — String, tipe: string (string yang dikodekan UTF-8).

    Parameter query OpenCypher untuk eksekusi query. Lihat Contoh kueri parameter OpenCypher untuk informasi selengkapnya.

Respons

  • results— Diperlukan: Dokumen, tipe: document (konten terbuka protokol-agnostik yang diwakili oleh model data seperti JSON).

    Hasil OpenCypherQuery.

Galat

ExecuteOpenCypherExplainQuery (tindakan)

        Nama AWS CLI untuk API ini adalah:. execute-open-cypher-explain-query

Mengeksekusi permintaan OpenCypherexplain. Lihat fitur penjelasan OpenCypher untuk informasi selengkapnya.

Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM di cluster itu. ReadDataViaQuery

Perhatikan bahwa kunci kondisi OpenCypher IAM neptune-db:QueryLanguage: dapat digunakan dalam dokumen kebijakan untuk membatasi penggunaan kueri OpenCypher (lihat Kunci kondisi yang tersedia dalam pernyataan kebijakan akses data IAM Neptunus).

Permintaan

  • explainMode(dalam CLI:--explain-mode) - Wajib: an OpenCypherExplainMode, tipe: string (string yang dikodekan UTF-8).

    Mode OpenCypherexplain. Bisa menjadi salah satu dari:static,dynamic, ataudetails.

  • openCypherQuery(dalam CLI:--open-cypher-query) - Diperlukan: String, tipe: string (string yang dikodekan UTF-8).

    String query OpenCypher.

  • parameters(dalam CLI:--parameters) — String, tipe: string (string yang dikodekan UTF-8).

    Parameter kueri OpenCypher.

Respons

  • results— Diperlukan: Gumpalan, tipe: blob (blok data biner yang tidak ditafsirkan).

    Sebuah gumpalan teks yang berisi hasil OpenCypherexplain.

Galat

ListOpenCypherQueries (tindakan)

        Nama AWS CLI untuk API ini adalah:. list-open-cypher-queries

Daftar query OpenCypher aktif. Lihat titik akhir status Neptunus OpenCypher untuk informasi lebih lanjut.

Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM di cluster itu. GetQueryStatus

Perhatikan bahwa kunci kondisi OpenCypher IAM neptune-db:QueryLanguage: dapat digunakan dalam dokumen kebijakan untuk membatasi penggunaan kueri OpenCypher (lihat Kunci kondisi yang tersedia dalam pernyataan kebijakan akses data IAM Neptunus).

Permintaan

  • includeWaiting(dalam CLI:--include-waiting) — Boolean, dari tipe: boolean (nilai Boolean (benar atau salah)).

    Ketika disetel ke TRUE dan parameter lain tidak ada, menyebabkan informasi status dikembalikan untuk kueri menunggu serta untuk menjalankan kueri.

Respons

  • acceptedQueryCount— Integer, tipe: integer (integer 32-bit yang ditandatangani).

    Jumlah kueri yang telah diterima tetapi belum selesai, termasuk kueri dalam antrian.

  • queries – Susunan objek GremlinQueryStatus.

    Daftar kueri OpenCypher saat ini.

  • runningQueryCount— Integer, tipe: integer (integer 32-bit yang ditandatangani).

    Jumlah kueri OpenCypher yang sedang berjalan.

Galat

GetOpenCypherQueryStatus (tindakan)

        Nama AWS CLI untuk API ini adalah:. get-open-cypher-query-status

Mengambil status query OpenCypher tertentu.

Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM di cluster itu. GetQueryStatus

Perhatikan bahwa kunci kondisi OpenCypher IAM neptune-db:QueryLanguage: dapat digunakan dalam dokumen kebijakan untuk membatasi penggunaan kueri OpenCypher (lihat Kunci kondisi yang tersedia dalam pernyataan kebijakan akses data IAM Neptunus).

Permintaan

  • queryId(dalam CLI:--query-id) - Diperlukan: String, tipe: string (string yang dikodekan UTF-8).

    ID unik dari query OpenCypher untuk mengambil status query.

Respons

  • queryEvalStats — Sebuah objek QueryEvalStats.

    Status evaluasi kueri OpenCypher.

  • queryId— String, tipe: string (string yang dikodekan UTF-8).

    ID unik dari kueri yang statusnya dikembalikan.

  • queryString— String, tipe: string (string yang dikodekan UTF-8).

    String query OpenCypher.

Galat

CancelOpenCypherQuery (tindakan)

        Nama AWS CLI untuk API ini adalah:. cancel-open-cypher-query

Membatalkan query OpenCypher tertentu. Lihat titik akhir status Neptunus OpenCypher untuk informasi lebih lanjut.

Saat menjalankan operasi ini di cluster Neptunus yang mengaktifkan autentikasi IAM, pengguna IAM atau peran yang membuat permintaan harus memiliki kebijakan yang dilampirkan yang memungkinkan tindakan neptune-db: IAM di cluster itu. CancelQuery

Permintaan

  • queryId(dalam CLI:--query-id) - Diperlukan: String, tipe: string (string yang dikodekan UTF-8).

    ID unik dari kueri OpenCypher untuk dibatalkan.

  • silent(dalam CLI:--silent) — Boolean, dari tipe: boolean (nilai Boolean (benar atau salah)).

    Jika disetel keTRUE, menyebabkan pembatalan kueri OpenCypher terjadi secara diam-diam.

Respons

  • payload— Boolean, tipe: boolean (nilai Boolean (benar atau salah)).

    Payload pembatalan untuk kueri OpenCypher.

  • status— String, tipe: string (string yang dikodekan UTF-8).

    Status pembatalan kueri OpenCypher.

Galat

Struktur kueri:

QueryEvalStats (struktur)

Struktur untuk menangkap statistik kueri seperti berapa banyak kueri yang berjalan, diterima atau menunggu dan detailnya.

Bidang

  • cancelled— Ini adalah Boolean, dari tipe: boolean (nilai Boolean (benar atau salah)).

    Setel ke TRUE jika kueri dibatalkan, atau FALSE sebaliknya.

  • elapsed— Ini adalah Integer, tipe: integer (integer 32-bit yang ditandatangani).

    Jumlah milidetik kueri telah berjalan sejauh ini.

  • subqueries— Ini adalah Dokumen, dari tipe: document (konten terbuka protokol-agnostik yang diwakili oleh model data seperti JSON).

    Jumlah subquery dalam query ini.

  • waited— Ini adalah Integer, tipe: integer (integer 32-bit yang ditandatangani).

    Menunjukkan berapa lama kueri menunggu, dalam milidetik.

GremlinQueryStatus (struktur)

Menangkap status kueri Gremlin (lihat halaman API status kueri Gremlin).

Bidang

  • queryEvalStatsIni adalah sebuah QueryEvalStats objek.

    Statistik kueri dari kueri Gremlin.

  • queryId— Ini adalah String, tipe: string (string yang dikodekan UTF-8).

    ID dari kueri Gremlin.

  • queryString— Ini adalah String, tipe: string (string yang dikodekan UTF-8).

    String query dari query Gremlin.

GremlinQueryStatusAttributes (struktur)

Berisi komponen status dari query Gremlin.

Bidang

  • attributes— Ini adalah Dokumen, dari tipe: document (konten terbuka protokol-agnostik yang diwakili oleh model data seperti JSON).

    Atribut status kueri Gremlin.

  • code— Ini adalah Integer, tipe: integer (integer 32-bit yang ditandatangani).

    Kode respons HTTP dikembalikan dari permintaan kueri Gremlin..

  • message— Ini adalah String, tipe: string (string yang dikodekan UTF-8).

    Pesan status.