StreamingQuery

Handel ke kueri yang dijalankan terus menerus di latar belakang saat data baru tiba. Semua metode aman untuk utas.

Sintaksis

# Returned by DataStreamWriter.start() or DataStreamWriter.toTable()
q = df.writeStream.format("console").start()

Karakteristik

Harta benda Deskripsi
id Mengembalikan ID unik kueri ini yang bertahan di seluruh mulai ulang dari data titik pemeriksaan.
runId Mengembalikan ID unik kueri ini yang tidak bertahan di seluruh hidupkan ulang.
name Mengembalikan nama kueri yang ditentukan pengguna, atau None jika tidak ditentukan.
isActive Mengembalikan apakah kueri streaming ini saat ini aktif.
status Mengembalikan status kueri saat ini sebagai dict.
recentProgress Mengembalikan array pembaruan terbaru StreamingQueryProgress untuk kueri ini.
lastProgress Mengembalikan pembaruan terbaru StreamingQueryProgress , atau None jika belum ada pembaruan.

Metode

Metode Deskripsi
awaitTermination(timeout) Menunggu penghentian kueri ini, baik menurut stop() atau dengan pengecualian.
processAllAvailable() Memblokir hingga semua data yang tersedia di sumber telah diproses dan diterapkan ke sink. Ditujukan untuk pengujian.
stop() Menghentikan kueri streaming ini.
explain(extended) Mencetak paket (logis dan fisik) ke konsol untuk penelusuran kesalahan.
exception() Mengembalikan StreamingQueryException jika kueri dihentikan dengan pengecualian, atau None.

Examples

sdf = spark.readStream.format("rate").load()
sq = sdf.writeStream.format('memory').queryName('this_query').start()
sq.isActive
# True
sq.name
# 'this_query'
sq.awaitTermination(5)
# False
sq.stop()
sq.isActive
# False