

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

# Neptunus mengalirkan API jalur data
<a name="data-api-dp-streams"></a>

**Tindakan akses streaming:**
+ [GetPropertygraphStream (tindakan)](#GetPropertygraphStream)

**Struktur data aliran:**
+ [PropertygraphRecord (struktur)](#PropertygraphRecord)
+ [PropertygraphData (struktur)](#PropertygraphData)

## GetPropertygraphStream (tindakan)
<a name="GetPropertygraphStream"></a>

         Nama AWS CLI untuk API ini adalah:. `get-propertygraph-stream`

Mendapat aliran untuk grafik properti.

Dengan fitur Neptunus Streams, Anda dapat menghasilkan urutan lengkap entri log perubahan yang merekam setiap perubahan yang dilakukan pada data grafik Anda saat itu terjadi. `GetPropertygraphStream`memungkinkan Anda mengumpulkan entri log perubahan ini untuk grafik properti.

Fitur aliran Neptunus perlu diaktifkan di Neptunus Anda. DBcluster Untuk mengaktifkan aliran, setel parameter cluster DB [neptune\$1streams](https://docs.aws.amazon.com/neptune/latest/userguide/parameters.html#parameters-db-cluster-parameters-neptune_streams) ke. `1`

Lihat [Menangkap perubahan grafik secara real time menggunakan aliran Neptunus](https://docs.aws.amazon.com/neptune/latest/userguide/streams.html).

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](https://docs.aws.amazon.com/neptune/latest/userguide/iam-dp-actions.html#getstreamrecords) cluster itu. GetStreamRecords

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, tergantung pada kueri:

Perhatikan bahwa Anda dapat membatasi kueri grafik properti menggunakan kunci konteks IAM berikut:
+ [neptunus-db ::Gremlin QueryLanguage](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys)
+ [neptunus-db:: QueryLanguage OpenCypher](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html#iam-neptune-condition-keys)

Lihat [Kunci kondisi yang tersedia di pernyataan kebijakan akses data IAM Neptunus](https://docs.aws.amazon.com/neptune/latest/userguide/iam-data-condition-keys.html)).

**Permintaan**
+ **commitNum**(dalam CLI:`--commit-num`) — Panjang, tipe: `long` (integer 64-bit yang ditandatangani).

  Jumlah commit dari catatan awal yang akan dibaca dari stream log perubahan. Parameter ini `iteratorType` diperlukan saat `AT_SEQUENCE_NUMBER` atau`AFTER_SEQUENCE_NUMBER`, dan diabaikan kapan `iteratorType` `TRIM_HORIZON` atau`LATEST`.
+ **encoding**(dalam CLI:`--encoding`) — Pengkodean, tipe: `string` (string yang dikodekan UTF-8).

  Jika disetel ke TRUE, Neptunus memampatkan respons menggunakan pengkodean gzip.
+ **iteratorType**(dalam CLI:`--iterator-type`) — sebuah IteratorType, dari tipe: `string` (string yang dikodekan UTF-8).

  Bisa menjadi salah satu dari:
  + `AT_SEQUENCE_NUMBER`— Menunjukkan bahwa pembacaan harus dimulai dari nomor urut acara yang ditentukan bersama oleh `opNum` parameter `commitNum` dan.
  + `AFTER_SEQUENCE_NUMBER`— Menunjukkan bahwa pembacaan harus dimulai tepat setelah nomor urut acara yang ditentukan bersama oleh `opNum` parameter `commitNum` dan.
  + `TRIM_HORIZON`— Menunjukkan bahwa pembacaan harus dimulai pada catatan terakhir yang belum dipangkas dalam sistem, yang merupakan catatan tertua yang belum kedaluwarsa (belum dihapus) dalam aliran log perubahan.
  + `LATEST`— Menunjukkan bahwa pembacaan harus dimulai pada catatan terbaru dalam sistem, yang merupakan catatan terbaru yang belum kedaluwarsa (belum dihapus) dalam aliran log perubahan.
+ **limit**(dalam CLI:`--limit`) — a GetPropertygraphStreamInputLimitLong, tipe: `long` (integer 64-bit yang ditandatangani), tidak kurang dari 1 atau lebih dari 100000? st? s.

  Menentukan angka maksimum catatan yang akan dikembalikan. Ada juga batas ukuran 10 MB pada respon yang tidak dapat diubah dan yang diutamakan daripada jumlah catatan yang ditentukan dalam parameter `limit`. Respon mencakup catatan pelanggaran ambang batas jika batas 10 MB tercapai.

  Rentang untuk `limit` adalah 1 hingga 100.000, dengan default 10.
+ **opNum**(dalam CLI:`--op-num`) — Panjang, tipe: `long` (integer 64-bit yang ditandatangani).

  Nomor urut operasi dalam commit yang ditentukan untuk mulai dibaca dari dalam data stream log perubahan. Nilai default-nya `1`.

**Respons**
+ **format**— *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).

  Format serialisasi untuk catatan perubahan yang dikembalikan. Saat ini, satu-satunya nilai yang didukung adalah `PG_JSON`.
+ **lastEventId**— *Wajib:* Ini adalah array peta pasangan kunci-nilai di mana:

      Setiap kunci adalah String, tipe: `string` (string yang dikodekan UTF-8).

      Setiap nilai adalah String, tipe: `string` (string yang dikodekan UTF-8).

  Pengidentifikasi urutan dari perubahan terakhir dalam respons aliran.

  ID peristiwa terdiri dari dua bidang: a`commitNum`, yang mengidentifikasi transaksi yang mengubah grafik, dan`opNum`, yang mengidentifikasi operasi tertentu dalam transaksi itu:  
**Example**  

  ```
  "eventId": {
            "commitNum": 12,
            "opNum": 1
          }
  ```
+ **lastTrxTimestampInMillis**— *Diperlukan:* Panjang, tipe: `long` (integer 64-bit yang ditandatangani).

  Waktu di mana komit untuk transaksi diminta, dalam milidetik dari zaman Unix.
+ **records** – *Wajib:* Susunan objek [PropertygraphRecord](#PropertygraphRecord).

  Array catatan aliran log perubahan serial yang disertakan dalam respons.
+ **totalRecords**— *Diperlukan:* Integer, tipe: `integer` (integer 32-bit yang ditandatangani).

  Jumlah total catatan dalam tanggapan.

**Kesalahan**
+ [UnsupportedOperationException](data-api-dp-errors.md#UnsupportedOperationException)
+ [ExpiredStreamException](data-api-dp-errors.md#ExpiredStreamException)
+ [InvalidParameterException](data-api-dp-errors.md#InvalidParameterException)
+ [MemoryLimitExceededException](data-api-dp-errors.md#MemoryLimitExceededException)
+ [StreamRecordsNotFoundException](data-api-dp-errors.md#StreamRecordsNotFoundException)
+ [ClientTimeoutException](data-api-dp-errors.md#ClientTimeoutException)
+ [PreconditionsFailedException](data-api-dp-errors.md#PreconditionsFailedException)
+ [ThrottlingException](data-api-dp-errors.md#ThrottlingException)
+ [ConstraintViolationException](data-api-dp-errors.md#ConstraintViolationException)
+ [InvalidArgumentException](data-api-dp-errors.md#InvalidArgumentException)
+ [IllegalArgumentException](data-api-dp-errors.md#IllegalArgumentException)
+ [TooManyRequestsException](data-api-dp-errors.md#TooManyRequestsException)

## *Struktur data aliran:*
<a name="data-api-dp-streams-stream-data-structures-spacer"></a>

## PropertygraphRecord (struktur)
<a name="PropertygraphRecord"></a>

Struktur catatan grafik properti.

**Bidang**
+ **commitTimestampInMillis**— Ini *Diperlukan:* Panjang, tipe: `long` (integer 64-bit yang ditandatangani).

  Waktu di mana komit untuk transaksi diminta, dalam milidetik dari zaman Unix.
+ **data**— Ini *Diperlukan:* Sebuah [PropertygraphData](#PropertygraphData) objek.

  Catatan perubahan Gremlin atau OpenCypher yang diserialisasi.
+ **eventId**— Ini *Diperlukan:* Ini adalah array peta pasangan kunci-nilai di mana:

      Setiap kunci adalah String, tipe: `string` (string yang dikodekan UTF-8).

      Setiap nilai adalah String, tipe: `string` (string yang dikodekan UTF-8).

  Pengidentifikasi urutan catatan perubahan aliran.
+ **isLastOp**— Ini adalah Boolean, dari tipe: `boolean` (nilai Boolean (benar atau salah)).

  Hanya hadir jika operasi ini adalah yang terakhir dalam transaksinya. Jika ada, itu diatur ke true. Ini berguna untuk memastikan bahwa seluruh transaksi dikonsumsi.
+ **op**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).

  Operasi yang menciptakan perubahan.

## PropertygraphData (struktur)
<a name="PropertygraphData"></a>

Catatan perubahan Gremlin atau OpenCypher.

**Bidang**
+ **from**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).

  Jika ini adalah tepi (tipe =`e`), ID dari simpul atau `from` simpul sumber yang sesuai.
+ **id**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).

  ID dari elemen Gremlin atau OpenCypher.
+ **key**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).

  Nama properti. Untuk label elemen, ini adalah`label`.
+ **to**— Ini adalah String, tipe: `string` (string yang dikodekan UTF-8).

  Jika ini adalah tepi (tipe =`e`), ID dari simpul atau `to` simpul target yang sesuai.
+ **type**— Ini *Diperlukan:* String, tipe: `string` (string yang dikodekan UTF-8).

  Jenis elemen Gremlin atau OpenCypher ini. Harus menjadi salah satu dari:
  + **`v1`**- Label Vertex untuk Gremlin, atau label node untuk OpenCypher.
  + **`vp`**- Properti Vertex untuk Gremlin, atau properti node untuk OpenCypher.
  + **`e`**- Label tepi dan tepi untuk Gremlin, atau jenis hubungan dan hubungan untuk OpenCypher.
  + **`ep`**- Properti tepi untuk Gremlin, atau properti hubungan untuk OpenCypher.
+ **value**— Ini *Diperlukan:* Dokumen, tipe: `document` (konten terbuka protokol-agnostik yang diwakili oleh model data seperti JSON).

  Ini adalah objek JSON yang berisi bidang nilai untuk nilai itu sendiri, dan bidang tipe data untuk tipe data JSON dari nilai itu:  
**Example**  

  ```
  "value": {
            "value": "(the new value"),
            "dataType": "(the JSON datatypenew value")
          }
  ```