Compartilhar via


awaitTermination (StreamingQuery)

Aguarda o encerramento dessa consulta, por stop() ou por uma exceção. Se a consulta tiver sido encerrada com uma exceção, a exceção será gerada. Se timeout estiver definido, retornará se a consulta foi encerrada nos segundos limite.

Se a consulta já tiver sido encerrada, as chamadas subsequentes retornarão imediatamente (se interrompidas normalmente) ou lançarão a exceção imediatamente (se terminar com uma exceção).

Sintaxe

awaitTermination(timeout=None)

Parâmetros

Parâmetro Tipo Descrição
timeout int, opcional O número de segundos a aguardar. Se não estiver definido, aguardará indefinidamente.

Devoluções

bool ou None

Retorna True ou False se timeout está definido, indicando se a consulta foi encerrada dentro do tempo limite. Retorna None se nenhum tempo limite estiver definido.

Exemplos

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