QuestDBSender
Documentation for QuestDBSender
QuestDBClient.QuestDBSender.DEFAULT_BUFFER_SIZEQuestDBClient.QuestDBSender.AuthQuestDBClient.QuestDBSender.SenderQuestDBClient.QuestDBSender.clearQuestDBClient.QuestDBSender.closeQuestDBClient.QuestDBSender.connectQuestDBClient.QuestDBSender.flushQuestDBClient.QuestDBSender.write
QuestDBClient.QuestDBSender.DEFAULT_BUFFER_SIZE — Constantconst DEFAULT_BUFFER_SIZE::Int = 128 * 1024Default buffer size of the sender's buffer
QuestDBClient.QuestDBSender.Auth — TypeSee: https://questdb.io/docs/reference/api/ilp/authenticate
Authentication object used
QuestDBClient.QuestDBSender.Sender — Type@with_kw mutable struct Sender
host::String="127.0.0.1"
port::Int=9009
batchSize::Int=DEFAULT_BUFFER_SIZE
tlsMode::Bool=false
hasTable::Bool=false
hasFields::Bool=false
auth::Union{Auth, Nothing} = nothing ## Can be changed into a new
buffer::String = ""
socket::Union{TCPSocket, Nothing} = nothing
endSender struct is the entity responsible for connecting to the QuestDB Server, build records & send them using the ILP protocol.
Arguments
host::String- the host address. The default one is thelocalhostor127.0.0.1port::Int- the port connected to on the host machine. Default value is9009batchSize::Int- the buffer size beyond which the contents of the buffer written to the server. Default size is 128 * 1024hasTable::Bool- used to indicate if an ILP record statement has a table definedhasFields::Bool- used to indicate if an ILP record statement has fields definedbuffer::String- used to buffer ILP record statements before writing them to the serversocket::Union{TCPSocket, Nothing}- holds the socket connection to the QuestDB Server instance
QuestDBClient.QuestDBSender.write — Methodwrite(sender::Sender)Attempts to write the ILP record statements to the server. In case of an error, an exception is thrown
QuestDBClient.QuestDBSender.clear — Methodclear(sender::Sender)Clears the buffer contents
QuestDBClient.QuestDBSender.connect — Methodconnect(sender::Sender)Attempts to connect the sender to the server socket. In case of an error, an exception is thrown
QuestDBClient.QuestDBSender.flush — Methodflush(sender::Sender)Attempts to flush any unsent text to the server socket. In case of an error, an exception is thrown
QuestDBClient.QuestDBSender.close — Methodclose(sender::Sender)Attempts to close the sender's connection to the server. In case of an error, an exception is thrown