Skip to main content

InfluxDBPoint

Functions​

new​

</>
InfluxDBPoint.new(measurementName: string?) → InfluxDBPoint

Creates a new InfluxDB point

fromTableData​

</>
InfluxDBPoint.fromTableData(data: InfluxDBPointTableData) → InfluxDBPoint

Creates a new InfluxDB point from table data

isInfluxDBPoint​

</>
InfluxDBPoint.isInfluxDBPoint(point: any) → boolean

Checks if the point is an InfluxDBPoint

SetMeasurementName​

</>
InfluxDBPoint.SetMeasurementName(
name: string?
) → boolean

Sets the measurement name

GetMeasurementName​

</>
InfluxDBPoint.GetMeasurementName(self: InfluxDBPoint) → string?

Gets the measurement name

ToTableData​

</>
InfluxDBPoint.ToTableData(self: InfluxDBPoint) → InfluxDBPointTableData

Converts the point into a table data format safe for serialization

SetTimestamp​

</>
InfluxDBPoint.SetTimestamp(
timestamp: DateTime | nil
) → ()

If it's nil, the timestamp defaults to send time

AddTag​

</>
InfluxDBPoint.AddTag(
tagKey: string,
tagValue: string
) → ()

Tags are indexed, whereas fields are not.

AddIntField​

</>
InfluxDBPoint.AddIntField(
fieldName: string,
value: number
) → ()

Adds an int field

AddUintField​

</>
InfluxDBPoint.AddUintField(
fieldName: string,
value: number
) → ()

Adds a uint field

AddFloatField​

</>
InfluxDBPoint.AddFloatField(
fieldName: string,
value: number
) → ()

Adds a float field

AddBooleanField​

</>
InfluxDBPoint.AddBooleanField(
fieldName: string,
value: boolean
) → ()

Adds a boolean field

AddStringField​

</>
InfluxDBPoint.AddStringField(
fieldName: string,
value: string
) → ()

Adds a string field

ToLineProtocol​

</>
InfluxDBPoint.ToLineProtocol(
pointSettings: InfluxDBPointSettings
) → string?

Converts the point to line protocol format to send to InfluxDB for consumption

Show raw api
{
    "functions": [
        {
            "name": "new",
            "desc": "Creates a new InfluxDB point",
            "params": [
                {
                    "name": "measurementName",
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "InfluxDBPoint"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 41,
                "path": "src/influxdbclient/src/Shared/Write/InfluxDBPoint.lua"
            }
        },
        {
            "name": "fromTableData",
            "desc": "Creates a new InfluxDB point from table data",
            "params": [
                {
                    "name": "data",
                    "desc": "",
                    "lua_type": "InfluxDBPointTableData"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "InfluxDBPoint"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 60,
                "path": "src/influxdbclient/src/Shared/Write/InfluxDBPoint.lua"
            }
        },
        {
            "name": "isInfluxDBPoint",
            "desc": "Checks if the point is an InfluxDBPoint",
            "params": [
                {
                    "name": "point",
                    "desc": "",
                    "lua_type": "any"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 99,
                "path": "src/influxdbclient/src/Shared/Write/InfluxDBPoint.lua"
            }
        },
        {
            "name": "SetMeasurementName",
            "desc": "Sets the measurement name",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InfluxDBPoint"
                },
                {
                    "name": "name",
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 109,
                "path": "src/influxdbclient/src/Shared/Write/InfluxDBPoint.lua"
            }
        },
        {
            "name": "GetMeasurementName",
            "desc": "Gets the measurement name",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InfluxDBPoint"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 120,
                "path": "src/influxdbclient/src/Shared/Write/InfluxDBPoint.lua"
            }
        },
        {
            "name": "ToTableData",
            "desc": "Converts the point into a table data format safe for serialization",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InfluxDBPoint"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "InfluxDBPointTableData"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 129,
                "path": "src/influxdbclient/src/Shared/Write/InfluxDBPoint.lua"
            }
        },
        {
            "name": "SetTimestamp",
            "desc": "If it's nil, the timestamp defaults to send time",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InfluxDBPoint"
                },
                {
                    "name": "timestamp",
                    "desc": "",
                    "lua_type": "DateTime | nil"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 143,
                "path": "src/influxdbclient/src/Shared/Write/InfluxDBPoint.lua"
            }
        },
        {
            "name": "AddTag",
            "desc": "Tags are indexed, whereas fields are not.",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InfluxDBPoint"
                },
                {
                    "name": "tagKey",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "tagValue",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 155,
                "path": "src/influxdbclient/src/Shared/Write/InfluxDBPoint.lua"
            }
        },
        {
            "name": "AddIntField",
            "desc": "Adds an int field",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InfluxDBPoint"
                },
                {
                    "name": "fieldName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 168,
                "path": "src/influxdbclient/src/Shared/Write/InfluxDBPoint.lua"
            }
        },
        {
            "name": "AddUintField",
            "desc": "Adds a uint field",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InfluxDBPoint"
                },
                {
                    "name": "fieldName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 189,
                "path": "src/influxdbclient/src/Shared/Write/InfluxDBPoint.lua"
            }
        },
        {
            "name": "AddFloatField",
            "desc": "Adds a float field",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InfluxDBPoint"
                },
                {
                    "name": "fieldName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 211,
                "path": "src/influxdbclient/src/Shared/Write/InfluxDBPoint.lua"
            }
        },
        {
            "name": "AddBooleanField",
            "desc": "Adds a boolean field",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InfluxDBPoint"
                },
                {
                    "name": "fieldName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "boolean"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 228,
                "path": "src/influxdbclient/src/Shared/Write/InfluxDBPoint.lua"
            }
        },
        {
            "name": "AddStringField",
            "desc": "Adds a string field",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InfluxDBPoint"
                },
                {
                    "name": "fieldName",
                    "desc": "",
                    "lua_type": "string"
                },
                {
                    "name": "value",
                    "desc": "",
                    "lua_type": "string"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 241,
                "path": "src/influxdbclient/src/Shared/Write/InfluxDBPoint.lua"
            }
        },
        {
            "name": "ToLineProtocol",
            "desc": "Converts the point to line protocol format to send to InfluxDB for consumption",
            "params": [
                {
                    "name": "self",
                    "desc": "",
                    "lua_type": "InfluxDBPoint"
                },
                {
                    "name": "pointSettings",
                    "desc": "",
                    "lua_type": "InfluxDBPointSettings"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "string?"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 254,
                "path": "src/influxdbclient/src/Shared/Write/InfluxDBPoint.lua"
            }
        }
    ],
    "properties": [],
    "types": [],
    "name": "InfluxDBPoint",
    "desc": "",
    "source": {
        "line": 5,
        "path": "src/influxdbclient/src/Shared/Write/InfluxDBPoint.lua"
    }
}