Skema grafik properti

neptune.graph.pg_schema()Prosedur ini memberikan gambaran komprehensif tentang struktur grafik properti Anda. Ini mengembalikan semua label node, label tepi, properti dengan tipe data mereka, dan label tripel ({~from, ~type, ~to}pola yang menggambarkan bagaimana tipe node terhubung melalui tipe tepi).

Prosedur ini saat ini hanya tersedia melalui titik akhir OpenCypher dan menemukan skema untuk semua data grafik properti.

Gunakan prosedur ini untuk tugas-tugas seperti:

Perbandingan dengan Neptune Analytics

Dalam Neptune Analytics, neptune.graph.pg_schema() sinkron. Ini menghitung skema pada setiap panggilan.

Di Neptune Database, Anda secara eksplisit memicu perhitungan skema asinkron dengan memanggilneptune.graph.pg_schema.compute(), yang segera kembali. Perhitungan berjalan di latar belakang saat Anda melakukan polling untuk penyelesaian menggunakanneptune.graph.pg_schema(). Setelah dihitung, Neptunus mempertahankan skema dan mengembalikannya secara instan pada pembacaan berikutnya tanpa perhitungan ulang. Hasil paruh juga tersedia saat perhitungan masih berlangsung. Anda juga dapat menghentikan komputasi yang sedang berjalan dan melanjutkannya nanti.

Perbandingan dengan Graph Ringkasan API

Grap h Ringkasan API tidak menyediakan rangkap tiga label atau tipe data properti. Prosedur skema grafik properti mengisi celah ini. Tiga label menunjukkan pola hubungan tertentu dalam grafik Anda. Misalnya, a Person terhubung ke Company melalui worksAt tepi. Informasi ini sangat penting bagi LLM untuk menghasilkan kueri yang benar secara semantik.

Prasyarat

Versi mesin

Prosedur skema grafik properti memerlukan mesin Neptune versi 1.4.8.0 atau yang lebih baru.

Izin IAM

Tindakan IAM berikut diperlukan untuk setiap operasi skema:

stop()Operasi compute() dan memerlukan izin menulis karena mereka memodifikasi status internal yang digunakan untuk cache dan mempertahankan skema.

{
  "Version": "2012-10-17",
  "Statement": [{
    "Effect": "Allow",
    "Action": [
      "neptune-db:ReadDataViaQuery",
      "neptune-db:WriteDataViaQuery"
    ],
    "Resource": "arn:aws:neptune-db:us-east-1:123456789012:cluster-resource-id/*"
  }]
}

Untuk memberikan akses read-only ke skema (tanpa kemampuan untuk memicu komputasi), gunakan saja. neptune-db:ReadDataViaQuery

Contoh penulis dan pembaca

Anda dapat memicu komputasi skema hanya pada instance penulis. Instans replika baca dapat membaca skema (yang direplikasi dari penulis) tetapi tidak dapat menjalankan compute() ataustop().

Referensi API

Baca skema

Mengambil skema saat ini dan status komputasi.

Sintaksis:

Perilaku: Kem bali segera dengan skema dan status saat ini. Selalu tidak memblokir. Jika tidak ada skema yang dihitung, mengembalikan state: "NotStarted" dengan bidang skema kosong. Jika komputasi sedang berlangsung, mengembalikan hasil parSIAL dengan state:"InProgress".

Format tanggapan:

Respons berisi objek skema dengan bidang berikut:

Objek status:

Objek skema:

Jenis data yang didukung: StringInt,Long,Double,Bool, Date

Jika properti memiliki beberapa tipe data di seluruh node yang berbeda (misalnya, beberapa node menyimpan age sebagai Int dan lainnya sebagaiString), semua tipe yang diamati terdaftar dalam datatypes array.

Skema komputasi

Memicu perhitungan skema latar belakang.

Sintaksis:

Tindakan IAM diperlukan: dan neptune-db:ReadDataViaQuery neptune-db:WriteDataViaQuery

Parameter:

Perilaku:

Respon: Mengem balikan objek status yang menunjukkan status: "InProgress" dengan progressPercentage bidang concurrency dan.

Hentikan perhitungan skema

Menghentikan komputasi latar belakang yang sedang berjalan.

Sintaksis:

Tindakan IAM diperlukan: dan neptune-db:ReadDataViaQuery neptune-db:WriteDataViaQuery

Perilaku:

Respon: Mengembalikan objek status yang menunjukkan state: "Stopped" dengan arusprogressPercentage.

Menggunakan YIELD dengan hasil skema

Anda dapat menggunakan YIELD untuk mengekstrak bidang skema dan menggabungkannya dengan kueri lain. Contoh berikut mengambil semua label node dan menghitung jumlah node untuk setiap label. collSort()Fungsi mengurutkan daftar menurut abjad:

CALL neptune.graph.pg_schema()
  YIELD schema
  WITH schema.nodeLabels as nl
  UNWIND collSort(nl) as label
  MATCH (n)
  WHERE label in labels(n)
  RETURN label, COUNT(n) as count

Contoh output:

{
  "results": [{
      "label": "airport",
      "count": 3503
    }, {
      "label": "continent",
      "count": 7
    }, {
      "label": "country",
      "count": 237
    }, {
      "label": "version",
      "count": 1
    }]
}

Siklus hidup komputasi skema

Operasi asinkron

Komputasi skema adalah operasi asinkron. Ketika Anda menelep neptune.graph.pg_schema.compute() on, itu segera kembali dengan status saat ini. Perhitungan berjalan di latar belakang. Anda melakukan polling untuk kemajuan dan penyelesaian dengan memanggilneptune.graph.pg_schema(), yang mengembalikan status saat ini danprogressPercentage.

Status

Komputasi skema bergerak melalui status berikut:

Perilaku ketekunan dan restart

Skema yang dihitung dipertahankan dan selamat dari restart mesin. Perilaku restart tergantung pada status pada saat restart:

Hasil paruh

Saat komputasi sedang berlangsung, pg_schema() mengembalikan hasil parSIAL. Ini termasuk skema yang telah selesai sebelumnya digabungkan dengan label, properti, dan rangkap tiga yang ditemukan sejauh ini dalam perhitungan saat ini. Ini berarti Anda tidak perlu menunggu perhitungan penuh untuk selesai sebelum mengambil informasi skema yang berguna.

Replika baca

Instans replika baca dapat membaca skema menggunakanCALL neptune.graph.pg_schema(). Neptunus mereplikasi skema dari instance penulis dan membuatnya tersedia pada replika segera saat elemen skema ditemukan pada penulis.

Replika baca tidak dapat dijalankan compute() ataustop(). Panggilan ini mengembalikan kesalahan:

Praktik terbaik

Batasan

Output sampel

Contoh berikut menunjukkan keluaran skema untuk dataset rute udara:

awscurl -X POST https://your-neptune-endpoint:port/openCypher \
  -H "Content-Type: application/x-www-form-urlencoded" \
  --region us-east-1 --service neptune-db \
  -d 'query=CALL neptune.graph.pg_schema()'

{
  "results": [{
      "schema": {
        "edgeLabelDetails": {
          "route": {
            "properties": {
              "dist": ["Int"]
            }
          },
          "contains": {
            "properties": {}
          }
        },
        "edgeLabels": ["route", "contains"],
        "status": {
          "concurrency": "16",
          "lastComputedTimestamp": "2026-06-04T23:58:17Z",
          "state": "Completed",
          "progressPercentage": "100"
        },
        "nodeLabels": ["version", "continent", "airport", "country"],
        "labelTriples": [{
            "~type": "route",
            "~from": "airport",
            "~to": "airport"
          }, {
            "~type": "contains",
            "~from": "country",
            "~to": "airport"
          }, {
            "~type": "contains",
            "~from": "continent",
            "~to": "airport"
          }],
        "nodeLabelDetails": {
          "continent": {
            "properties": {
              "type": ["String"],
              "code": ["String"],
              "desc": ["String"]
            }
          },
          "airport": {
            "properties": {
              "type": ["String"],
              "city": ["String"],
              "icao": ["String"],
              "code": ["String"],
              "country": ["String"],
              "lat": ["Double"],
              "longest": ["Int"],
              "runways": ["Int"],
              "desc": ["String"],
              "lon": ["Double"],
              "region": ["String"],
              "elev": ["Int"]
            }
          },
          "country": {
            "properties": {
              "type": ["String"],
              "code": ["String"],
              "desc": ["String"]
            }
          },
          "version": {
            "properties": {
              "date": ["String"],
              "desc": ["String"],
              "author": ["String"],
              "type": ["String"],
              "code": ["String"]
            }
          }
        }
      }
    }]
}