Skip to main content

InfluxDBWriteBuffer

This item only works when running on the server. Server

Buffer for influx DB points.

Functions​

new​

</>
InfluxDBWriteBuffer.new(
writeOptions: InfluxDBWriteOptions,
promiseHandleFlush: (entries: {string}) → Promise.Promise<()>
) → InfluxDBWriteBuffer

Creates a new InfluxDB write buffer.

Add​

</>
InfluxDBWriteBuffer.Add(
entry: string
) → ()

Adds an entry to the buffer. If the buffer is full, it will flush

PromiseFlush​

</>
InfluxDBWriteBuffer.PromiseFlush(self: InfluxDBWriteBuffer) → Promise<()>

Flushes all entries in the buffer. Returns a promise that resolves when the flush is complete.

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new InfluxDB write buffer.",
            "params": [
                {
                    "name": "writeOptions",
                    "desc": "",
                    "lua_type": "InfluxDBWriteOptions"
                },
                {
                    "name": "promiseHandleFlush",
                    "desc": "",
                    "lua_type": "(entries: { string }) -> Promise.Promise<()>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "InfluxDBWriteBuffer"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 41,
                "path": "src/influxdbclient/src/Server/Write/InfluxDBWriteBuffer.lua"
            }
        },
        {
            "name": "Add",
            "desc": "Adds an entry to the buffer. If the buffer is full, it will flush",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InfluxDBWriteBuffer"
                },
                {
                    "name": "entry",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 64,
                "path": "src/influxdbclient/src/Server/Write/InfluxDBWriteBuffer.lua"
            }
        },
        {
            "name": "PromiseFlush",
            "desc": "Flushes all entries in the buffer. Returns a promise that resolves when the flush is complete.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InfluxDBWriteBuffer"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "Promise<()>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 124,
                "path": "src/influxdbclient/src/Server/Write/InfluxDBWriteBuffer.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "InfluxDBWriteBuffer",
    "desc": "Buffer for influx DB points.",
    "realm": [
        "Server"
    ],
    "source": {
        "line": 8,
        "path": "src/influxdbclient/src/Server/Write/InfluxDBWriteBuffer.lua"
    }
}