View a markdown version of this page

Metadata Koneksi dan API Pratinjau - AWS Lem
 —  tipe data  —EntitasBidang —  operasi  —ListEntities (daftar_entitas)DescribeEntity (deskripsi_entitas)GetEntityRecords (dapat_entity_record)

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

Metadata Koneksi dan API Pratinjau

API koneksi berikut menjelaskan operasi untuk menjelaskan metadata koneksi.

Jenis Data

Struktur entitas

Entitas yang didukung oleh suatu yang diberikanConnectionType.

Bidang

  • EntityName— UTF-8 tali.

    Nama entitas.

  • Label— UTF-8 tali.

    Label yang digunakan untuk entitas.

  • IsParentEntity – Boolean.

    Nilai Boolean yang membantu menentukan apakah ada sub objek yang dapat dicantumkan.

  • Description— UTF-8 tali.

    Deskripsi entitas.

  • Category— UTF-8 tali.

    Jenis entitas yang hadir dalam respons. Nilai ini tergantung pada koneksi sumber. Misalnya ini SObjects untuk Salesforce dan databases atau schemas atau tables untuk sumber seperti Amazon Redshift.

  • CustomProperties – Susunan peta pasangan nilai kunci.

    Setiap kunci adalah UTF-8 string.

    Setiap nilai adalah UTF-8 string.

    Peta kunci opsional yang dapat dikembalikan untuk entitas oleh konektor.

Struktur lapangan

Ob Field jek memiliki informasi tentang properti berbeda yang terkait dengan bidang di konektor.

Bidang

  • FieldName— UTF-8 tali.

    Pengidentifikasi unik untuk bidang.

  • Label— UTF-8 tali.

    Label yang dapat dibaca digunakan untuk lapangan.

  • Description— UTF-8 tali.

    Deskripsi bidang.

  • FieldType— UTF-8 string (nilai yang valid: INT SMALLINT | BIGINT | FLOAT | LONG | DATE | BOOLEAN | MAP | ARRAY | STRING | TIMESTAMP | DECIMAL | BYTE | SHORT | DOUBLE | STRUCT | BINARY |UNION).

    Jenis data di lapangan.

  • IsPrimaryKey – Boolean.

    Menunjukkan apakah bidang ini dapat digunakan sebagai kunci utama untuk entitas yang diberikan.

  • IsNullable – Boolean.

    Menunjukkan apakah bidang ini dapat dibatalkan atau tidak.

  • IsRetrievable – Boolean.

    Menunjukkan apakah bidang ini dapat ditambahkan dalam klausa Select dari kueri SQL atau apakah dapat diambil atau tidak.

  • IsFilterable – Boolean.

    Menunjukkan apakah bidang ini dapat digunakan dalam klausa filter (WHEREklausa) dari pernyataan SQL saat menanyakan data.

  • IsPartitionable – Boolean.

    Menunjukkan apakah bidang tertentu dapat digunakan dalam mempartisi kueri yang dibuat ke SaaS.

  • IsCreateable – Boolean.

    Menunjukkan apakah bidang ini dapat dibuat sebagai bagian dari penulisan tujuan.

  • IsUpdateable – Boolean.

    Menunjukkan apakah bidang ini dapat diperbarui sebagai bagian dari penulisan tujuan.

  • IsUpsertable – Boolean.

    Menunjukkan apakah bidang ini dapat ditingkatkan sebagai bagian dari penulisan tujuan.

  • IsDefaultOnCreate – Boolean.

    Menunjukkan apakah bidang ini diisi secara otomatis saat objek dibuat, seperti dibuat pada stempel waktu.

  • SupportedValues— Sebuah array UTF-8 string.

    Daftar nilai yang didukung untuk bidang tersebut.

  • SupportedFilterOperators— Sebuah array UTF-8 string.

    Menunjukkan operator filter dukungan untuk bidang ini.

  • ParentField— UTF-8 tali.

    Nama bidang induk untuk bidang bersarang.

  • NativeDataType— UTF-8 tali.

    Jenis data yang dikembalikan oleh SaaS API, seperti “picklist” atau “textarea” dari Salesforce.

  • CustomProperties – Susunan peta pasangan nilai kunci.

    Setiap kunci adalah UTF-8 string.

    Setiap nilai adalah UTF-8 string.

    Peta kunci opsional yang dapat dikembalikan.

Operasi

ListEntities tindakan (Python: list_entity)

Mengembalikan entitas yang tersedia didukung oleh jenis koneksi.

Permintaan

  • ConnectionName— UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 255 byte, cocok denganSingle-line string pattern.

    Nama untuk koneksi yang memerlukan kredentif untuk menanyakan jenis koneksi apa pun.

  • CatalogId — String id katalog, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Single-line string pattern.

    ID katalog katalog yang berisi koneksi. Ini bisa null, Secara default, ID AWS Akun adalah ID katalog.

  • ParentEntityName— UTF-8 tali.

    Nama entitas induk yang ingin Anda daftarkan turunannya. Parameter ini mengambil jalur yang sepenuhnya memenuhi syarat dari entitas untuk membuat daftar entitas anak.

  • NextToken— UTF-8 string, tidak kurang dari 1 atau lebih dari 2048 byte panjang, cocok denganCustom string pattern #11.

    Sebuah token kelanjutan, disertakan jika ini adalah sebuah panggilan kelanjutan.

  • DataStoreApiVersion— UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 256 byte, cocok denganCustom string pattern #28.

    Versi API dari konektor SaaS.

Respons

  • Entities – Susunan objek Entitas.

    Daftar objek Entity.

  • NextToken— UTF-8 string, tidak kurang dari 1 atau lebih dari 2048 byte panjang, cocok denganCustom string pattern #11.

    Token lanjutan, hadir jika segmen saat ini bukan yang terakhir.

Kesalahan

  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

  • GlueEncryptionException

  • ValidationException

  • FederationSourceException

  • AccessDeniedException

DescribeEntity tindakan (Python: describe_entity)

Memberikan detail mengenai entitas yang digunakan dengan jenis koneksi, dengan deskripsi model data untuk setiap bidang dalam entitas yang dipilih.

Respons mencakup semua bidang yang membentuk entitas.

Permintaan

  • ConnectionName- Diperlukan: UTF-8 string, panjang tidak kurang dari 1 atau lebih dari 255 byte, cocok denganSingle-line string pattern.

    Nama koneksi yang berisi kredentif jenis koneksi.

  • CatalogId — String id katalog, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Single-line string pattern.

    ID katalog katalog yang berisi koneksi. Ini bisa null, Secara default, ID AWS Akun adalah ID katalog.

  • EntityName- Diperlukan: UTF-8 string.

    Nama entitas yang ingin Anda jelaskan dari jenis koneksi.

  • NextToken— UTF-8 string, tidak kurang dari 1 atau lebih dari 2048 byte panjang, cocok denganCustom string pattern #11.

    Sebuah token kelanjutan, disertakan jika ini adalah sebuah panggilan kelanjutan.

  • DataStoreApiVersion— UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 256 byte, cocok denganCustom string pattern #28.

    Versi API yang digunakan untuk penyimpanan data.

Respons

  • Fields – Susunan objek Bidang.

    Menjelaskan bidang untuk entitas konektor tersebut. Ini adalah daftar Field objek. Fieldsangat mirip dengan kolom dalam database. Ob Field jek memiliki informasi tentang properti yang berbeda yang terkait dengan bidang di konektor.

  • NextToken— UTF-8 string, tidak kurang dari 1 atau lebih dari 2048 byte panjang, cocok denganCustom string pattern #11.

    Token lanjutan, hadir jika segmen saat ini bukan yang terakhir.

Kesalahan

  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

  • GlueEncryptionException

  • ValidationException

  • FederationSourceException

  • AccessDeniedException

GetEntityRecords tindakan (Python: get_entity_records)

API ini digunakan untuk menanyakan data pratinjau dari jenis koneksi tertentu atau dari Katalog AWS Glue Data berbasis Amazon S3 asli.

Mengembalikan catatan sebagai array gumpalan JSON. Setiap catatan diformat menggunakan Jackson JsonNode berdasarkan jenis bidang yang ditentukan oleh DescribeEntity API.

Konektor Spark menghasilkan skema sesuai dengan pemetaan tipe data yang sama seperti di DescribeEntity API. Konektor Spark mengonversi data ke tipe data yang sesuai yang cocok dengan skema saat mengembalikan baris.

Permintaan

  • ConnectionName— UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 255 byte, cocok denganSingle-line string pattern.

    Nama koneksi yang berisi kredentif jenis koneksi.

  • CatalogId — String id katalog, sepanjang tidak kurang dari 1 atau lebih dari 255 byte, yang cocok dengan Single-line string pattern.

    ID katalog katalog yang berisi koneksi. Ini bisa null, Secara default, ID AWS Akun adalah ID katalog.

  • EntityName- Diperlukan: UTF-8 string.

    Nama entitas yang ingin kita kueri data pratinjau dari jenis koneksi yang diberikan.

  • NextToken— UTF-8 string, tidak kurang dari 1 atau lebih dari 2048 byte panjang, cocok denganCustom string pattern #11.

    Sebuah token kelanjutan, disertakan jika ini adalah sebuah panggilan kelanjutan.

  • DataStoreApiVersion— UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 256 byte, cocok denganCustom string pattern #28.

    Versi API dari konektor SaaS.

  • ConnectionOptions — Sebuah rangkaian peta pasangan nilai kunci, tidak lebih dari 100 pasang.

    Setiap kunci adalah UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 256 byte, cocok denganCustom string pattern #23.

    Setiap nilai adalah UTF-8 string, tidak kurang dari 1 atau lebih dari 256 byte panjang, cocok denganCustom string pattern #22.

    Opsi konektor yang diperlukan untuk menanyakan data.

  • FilterPredicate— UTF-8 string, tidak kurang dari 1 atau lebih dari 100000 byte panjangnya.

    Predikat filter yang dapat Anda terapkan dalam permintaan kueri.

  • Limit— Diperlukan: Jumlah (panjang), tidak kurang dari 1 atau lebih dari 1000.

    Membatasi jumlah catatan yang diambil dengan permintaan.

  • OrderBy— UTF-8 tali.

    Parameter yang mengurutkan data pratinjau respons.

  • SelectedFields— Sebuah array UTF-8 string, tidak kurang dari 1 atau lebih dari 1000 string.

    Daftar bidang yang ingin kita ambil sebagai bagian dari data pratinjau.

Respons

  • Records— Sebuah array struktur.

    Daftar objek yang diminta.

  • NextToken— UTF-8 string, panjangnya tidak kurang dari 1 atau lebih dari 2048 byte, cocok denganCustom string pattern #11.

    Token lanjutan, hadir jika segmen saat ini bukan yang terakhir.

Kesalahan

  • EntityNotFoundException

  • OperationTimeoutException

  • InvalidInputException

  • GlueEncryptionException

  • ValidationException

  • FederationSourceException

  • AccessDeniedException