Funciones

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Puede utilizar las funciones integradas siguientes en las cláusulas SELECT o WHERE de sus expresiones SQL.

abs(Decimal)

Devuelve el valor absoluto de un número. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: abs(-5) devuelve 5.

accountid()

Devuelve el ID de la cuenta que posee esta regla como un valor de tipo String. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo:

accountid() = "123456789012"

acos(Decimal)

Devuelve el coseno inverso de un número en radianes. Los argumentos Decimal se redondean con doble precisión antes de la aplicación de la función. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: acos(0) = 1.5707963267948966

asin(Decimal)

Devuelve el seno inverso de un número en radianes. Los argumentos Decimal se redondean con doble precisión antes de la aplicación de la función. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: asin(0) = 0.0

atan(Decimal)

Devuelve la tangente inversa de un número en radianes. Los argumentos Decimal se redondean con doble precisión antes de la aplicación de la función. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: atan(0) = 0.0

atan2(Decimal, Decimal)

Devuelve el ángulo, en radianes, entre el eje x positivo y el punto (x, y) definido en los dos argumentos.  El ángulo es positivo para los ángulos en sentido contrario a las agujas del reloj (plano medio superior y > 0) y es negativo para los ángulos que siguen el sentido de las agujas del reloj (plano medio inferior y < 0). Los argumentos Decimal se redondean con doble precisión antes de aplicar la función. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: atan2(1, 0) = 1.5707963267948966

aws_lambda(functionArn, inputJson)

Llama a la función de Lambda especificada que pasa inputJson a la función de Lambda y devuelve el JSON generado por la función de Lambda.

Debe conceder AWS IoT lambda:InvokeFunction permisos para invocar la función Lambda especificada. En el siguiente ejemplo, se muestra cómo se puede conceder el permiso lambda:InvokeFunction utilizando AWS CLI:

aws lambda add-permission --function-name "function_name"
--region "region"
--principal iot.amazonaws.com 
--source-arn arn:aws:iot:us-east-1:account_id:rule/rule_name
--source-account "account_id"
--statement-id "unique_id" 
--action "lambda:InvokeFunction"

A continuación, se indican los argumentos del comando add-permission:

Dada una carga de mensaje JSON como:

{
    "attribute1": 21,
    "attribute2": "value"
}

La función aws_lambda se puede utilizar para llamar a la función de Lambda de la siguiente manera:

SELECT
aws_lambda("arn:aws:lambda:us-east-1:account_id:function:lambda_function", {"payload":attribute1}) as output FROM 'topic-filter'

Si desea pasar la carga del mensaje MQTT completa, puede especificar la carga JSON mediante '*', como en el ejemplo siguiente.

SELECT
aws_lambda("arn:aws:lambda:us-east-1:account_id:function:lambda_function", *) as output FROM 'topic-filter'

payload.inner.element selecciona datos de mensajes publicados en el tema 'tema/subtema'.

some.value selecciona datos de la salida generada por la función de Lambda.

bitand(Int, Int)

Ejecuta una operación AND bit a bit en las representaciones de bits de los dos argumentos Int(-convertidos). Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: bitand(13, 5) = 5

bitor(Int, Int)

Realiza una operación OR bit a bit de las representaciones de bit de los dos argumentos. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: bitor(8, 5) = 13

bitxor(Int, Int)

Ejecuta una operación XOR bit a bit en las representaciones de bits de los dos argumentos Int(-convertidos). Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo:bitor(13, 5) = 8

bitnot(Int)

Ejecuta una operación NOT bit a bit en las representaciones de bits del argumento Int (convertido). Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: bitnot(13) = 2

cast()

Convierte un valor de un tipo de datos a otro tipo. Cast se comporta básicamente como las conversiones estándar, salvo que puede convertir números en valores booleanos o viceversa. Si AWS IoT no puede determinar cómo convertir un tipo en otro, el resultado es. Undefined Es compatible con la versión 2015-10-08 de SQL y versiones posteriores. Formato: fundido (valueastype).

Ejemplo:

cast(true as Int) = 1

Las siguientes palabras clave pueden aparecer después de "as" cuando se llama a cast:

Reglas de conversión:

ceil(Decimal)

Redondea el valor Decimal indicado al valor Int superior más cercano. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplos:

ceil(1.2) = 2

ceil(-1.2) = -1

chr(String)

Devuelve el carácter ASCII que corresponde al argumento Int determinado. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplos:

chr(65) = "A".

chr(49) = "1".

clientid()

Devuelve el ID del cliente MQTT que envía el mensaje o n/a si el mensaje no se ha enviado por MQTT. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo:

clientid() = "123456789012"

concat()

Concatena matrices o cadenas. Esta función acepta cualquier cantidad de argumentos y devuelve un valor String o un valor Array. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplos:

concat() = Undefined.

concat(1) = "1".

concat([1, 2, 3], 4) = [1, 2, 3, 4].

concat([1, 2, 3], "hello") = [1, 2, 3, "hello"]

concat("con", "cat") = "concat"

concat(1, "hello") = "1hello"

concat("he","is","man") = "heisman"

concat([1, 2, 3], "hello", [4, 5, 6]) = [1, 2, 3, "hello", 4, 5, 6]

cos(Decimal)

Devuelve el coseno de un número en radianes. Los argumentos Decimal se redondean con doble precisión antes de la aplicación de la función. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo:

cos(0) = 1.

cosh(Decimal)

Devuelve el coseno hiperbólico de un número en radianes. Los argumentos Decimal se redondean con doble precisión antes de la aplicación de la función. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: cosh(2.3) = 5.037220649268761.

decode(value, decodingScheme)

Utilice la función decode para descodificar un valor codificado. Si la cadena descodificada es un documento JSON, se devuelve un objeto direccionable. De lo contrario, la cadena descodificada se devuelve como una cadena. La función devuelve NULL si la cadena no se puede descodificar. Esta función admite la descodificación de cadenas codificadas en base64 y el formato de mensaje de búferes de protocolo (protobuf).

Es compatible con la versión SQL 2016-03-23 y versiones posteriores.

Descodificar cadenas codificadas en base64

En este ejemplo, la carga del mensaje incluye un valor codificado.

{
    encoded_temp: "eyAidGVtcGVyYXR1cmUiOiAzMyB9Cg=="
}

La función decode de esta instrucción SQL descodifica el valor de la carga del mensaje.

SELECT decode(encoded_temp,"base64").temperature AS temp from 'topic/subtopic'

Al descodificar el valor encoded_temp, se obtiene el siguiente documento JSON válido, que permite que la instrucción SELECT lea el valor de temperatura.

{ "temperature": 33 }

El resultado de la instrucción SELECT de este ejemplo se muestra aquí.

{ "temp": 33 }

Si el valor descodificado no era un documento JSON válido, el valor descodificado se devolvería en forma de cadena.

Descodificación de la carga de un mensaje de protobuf

Puede utilizar la función de decodificación de SQL para configurar una regla que pueda descodificar la carga de sus mensajes de protobuf. Para obtener más información, consulte Descodificar cargas de mensajes de protobuf.

La firma de la clase tiene el siguiente aspecto:

decode(<ENCODED DATA>, 'proto', '<S3 BUCKET NAME>', '<S3 OBJECT KEY>', '<PROTO NAME>', '<MESSAGE TYPE>')            

Un ejemplo de expresión SQL que utilice la función de descodificación de SQL puede tener el siguiente aspecto:

SELECT VALUE decode(*, 'proto', 's3-bucket', 'messageformat.desc', 'myproto', 'messagetype') FROM 'some/topic'

encode(value, encodingScheme)

Utilice la función encode para codificar la carga, que puede estar constituida por datos que no son JSON, en su representación de cadena basada en el esquema de codificación. Es compatible con la versión SQL 2016-03-23 y versiones posteriores.

endswith(String, String)

Devuelve un valor Boolean que indica si el primer argumento String termina con el segundo argumento String. Si alguno de los argumentos es Null o Undefined, el resultado es Undefined. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: endswith("cat","at") = true.

exp(Decimal)

Devuelve e elevado al argumento Decimal. Los argumentos Decimal se redondean con doble precisión antes de la aplicación de la función. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: exp(1) = e.

floor(Decimal)

Redondea a la baja el valor Decimal indicado al valor Int más cercano. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplos:

floor(1.2) = 1

floor(-1.2) = -2

introducción

Extrae un valor de un tipo de recopilación (matriz, cadena, objeto). No se aplica ninguna conversión al primer argumento. La conversión se aplica tal y como se documenta en la tabla del segundo argumento. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplos:

get(["a", "b", "c"], 1) = "b"

get({"a":"b"}, "a") = "b"

get("abc", 0) = “a”

get_dynamodb (Nombre de tabla,,,,, ROLearn partitionKeyName) partitionKeyValue sortKeyName sortKeyValue

Recupera datos de una tabla DymanoDB. get_dynamodb() permite consultar una tabla DynamoDB mientras se evalúa una regla. Puede filtrar o aumentar las cargas útiles de mensajes utilizando los datos recuperados de DynamoDB. Es compatible con la versión SQL 2016-03-23 y versiones posteriores.

get_dynamodb() utiliza los parámetros siguientes:

Como ejemplo de cómo usar get_dynamodb(), supongamos que tiene una tabla DynamoDB que contiene el ID de dispositivo e información de ubicación para todos los dispositivos conectados a AWS IoT. La siguiente instrucción SELECT utiliza la función get_dynamodb() para recuperar la ubicación del ID de dispositivo especificado:

SELECT *, get_dynamodb("InServiceDevices", "deviceId", id, "arn:aws:iam::12345678910:role/getdynamo").location AS location FROM 'some/topic'

get_mqtt_property(name)

Hace referencia a cualquiera de los siguientes MQTT5 encabezados:,, y. contentType payLoadFormatIndicator responseTopic correlationData Esta función toma como argumento cualquiera de las siguientes cadenas literales: content_type, format_indicator, response_topic y correlation_data. Para obtener más información, consulte la siguiente table de argumentos de la función.

En la siguiente tabla se muestran los argumentos de la función aceptables y los tipos de retorno asociados a la función get_mqtt_property:

El siguiente ejemplo de Rules SQL hace referencia a cualquiera de los siguientes MQTT5 encabezados:,, y. contentType payLoadFormatIndicator responseTopic correlationData

SELECT *, get_mqtt_property('content_type') as contentType,
          get_mqtt_property('format_indicator') as payloadFormatIndicator,
          get_mqtt_property('response_topic') as responseTopic,
          get_mqtt_property('correlation_data') as correlationData
FROM 'some/topic'

get_secret(secretId, secretType, key, roleArn)

Recupera el valor del campo SecretString o SecretBinary cifrado de la versión actual de un secreto en AWS Secrets Manager. Para obtener más información sobre la creación y el mantenimiento de secretos, consulte CreateSecretUpdateSecret, y PutSecretValue.

get_secret() utiliza los parámetros siguientes:

Ejemplos:

Puede usar la función get_secret en un encabezado de autenticación en una acción de regla HTTPS, como en el siguiente ejemplo de autenticación con clave de API.

"API_KEY": "${get_secret('API_KEY', 'SecretString', 'API_KEY_VALUE', 'arn:aws:iam::12345678910:role/getsecret')}"
            

Para obtener más información sobre la acción de regla HTTPS, consulte HTTP.

get_thing_shadow(thingName, shadowName, roleARN)

Devuelve la sombra especificada de la cosa especificado. Es compatible con la versión SQL 2016-03-23 y versiones posteriores.

Ejemplos:

Cuando se utilice con una sombra con nombre, proporcione el parámetro shadowName.

SELECT * from 'topic/subtopic'
WHERE
    get_thing_shadow("MyThing","MyThingShadow","arn:aws:iam::123456789012:role/AllowsThingShadowAccess")
    .state.reported.alarm = 'ON'

Cuando se utiliza con una sombra sin nombre, omita el parámetro shadowName.

SELECT * from 'topic/subtopic'
WHERE
    get_thing_shadow("MyThing","arn:aws:iam::123456789012:role/AllowsThingShadowAccess")
    .state.reported.alarm = 'ON'

get_user_properties () userPropertyKey

Hace referencia a las propiedades del usuario, que es un tipo de encabezados de propiedades que se admiten. MQTT5

Argumentos de la función

Para las siguientes propiedades de usuario en los encabezados de mensaje:

La siguiente table muestra el comportamiento de SQL esperado:

El siguiente ejemplo de reglas SQL hace referencia a las propiedades del usuario (un tipo de encabezado de MQTT5 propiedad) en la carga útil:

SELECT *, get_user_properties('user defined property key') as userProperty
FROM 'some/topic'

Funciones de hash

AWS IoT proporciona las siguientes funciones de hash:

Todas las funciones de hash esperan un argumento de cadena. El resultado es el valor con hash de dicha cadena. Las conversiones de cadena estándar se aplican a los argumentos que no son cadenas. Todas las funciones de hash son compatibles con la versión 2015-10-08 de SQL y con versiones posteriores.

Ejemplos:

md2("hello") = "a9046c73e00331af68917d3804f70655"

md5("hello") = "5d41402abc4b2a76b9719d911017c592"

indexof(String, String)

Devuelve el primer índice (basado en 0) del segundo argumento como subcadena del primer argumento. Se espera que ambos argumentos sean cadenas. Los argumentos que no sean cadenas están sujetos a las reglas de conversión estándar de cadenas. Esta función no se aplica a matrices, únicamente a cadenas. Es compatible con la versión SQL 2016-03-23 y versiones posteriores.

Ejemplos:

indexof("abcd", "bc") = 1

isNull()

Devuelve verdadero si el argumento es el valor Null. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplos:

isNull(5) = false.

isNull(Null) = true.

isUndefined()

Devuelve verdadero si el argumento tiene el valor Undefined. Es compatible con la versión SQL 2016-03-23 y versiones posteriores.

Ejemplos:

isUndefined(5) = false.

isUndefined(floor([1,2,3]))) = true.

length(String)

Devuelve el número de caracteres de la cadena suministrada. Se aplican las reglas de conversión estándar a los argumentos que no sean String. Es compatible con la versión SQL 2016-03-23 y versiones posteriores.

Ejemplos:

length("hi") = 2

length(false) = 5

ln(Decimal)

Devuelve el logaritmo natural del argumento. Los argumentos Decimal se redondean con doble precisión antes de la aplicación de la función. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: ln(e) = 1.

log(Decimal)

Devuelve el logaritmo decimal del argumento. Los argumentos Decimal se redondean con doble precisión antes de la aplicación de la función. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: log(100) = 2.0.

lower(String)

Muestra la versión en minúsculas del valor String indicado. Los argumentos que no son cadenas se convierten en cadenas con las reglas de conversión estándar. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplos:

lower("HELLO") = "hello".

lower(["HELLO"]) = "[\"hello\"]".

lpad(String, Int)

Devuelve el argumento String, rellenado en el lado izquierdo con el número de espacios especificado por el segundo argumento. El argumento Int debe estar comprendido entre 0 y 1000. Si el valor proporcionado se encuentra fuera de este rango válido, el argumento se establece en el valor válido más cercano (0 o 1000). Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplos:

lpad("hello", 2) = "  hello".

lpad(1, 3) = "   1"

ltrim(String)

Elimina todos los espacios en blanco del principio (tabuladores y espacios) del valor String proporcionado. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo:

Ltrim(" h i ") = "hi ".

machinelearning_predict(modelId, roleArn, record)

Utilice la machinelearning_predict función para realizar predicciones con los datos de un mensaje MQTT basado en un modelo de Amazon SageMaker AI. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores. Los argumentos de la función machinelearning_predict son:

La función devuelve un objeto JSON con los campos siguientes:

mod(Decimal, Decimal)

Devuelve el resto de la división del primer argumento por el segundo argumento. Es igual que remainder(Decimal, Decimal). También puede utilizar "%" como un operador infijo para la misma funcionalidad modulo. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: mod(8, 3) = 2.

nanval (,) AnyValue AnyValue

Devuelve el primer argumento si es un Decimal válido. De lo contrario, se devuelve el segundo argumento. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: Nanvl(8, 3) = 8.

newuuid()

Devuelve un UUID aleatorio de 16 bytes. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: newuuid() = 123a4567-b89c-12d3-e456-789012345000

numbytes(String)

Devuelve el número de bytes de la codificación UTF-8 de la cadena proporcionada. Se aplican las reglas de conversión estándar a los argumentos que no sean String. Es compatible con la versión SQL 2016-03-23 y versiones posteriores.

Ejemplos:

numbytes("hi") = 2

numbytes("€") = 3

parse_time(String, Long[, String])

Utilice la función parse_time para aplicar un formato legible a una marca de fecha y hora. Es compatible con la versión SQL 2016-03-23 y versiones posteriores. Para convertir una cadena de marca temporal en milisegundos, consulte time_to_epoch(String, String).

La función parse_time espera los argumentos siguientes:

Ejemplos:

Cuando este mensaje se publica en el tema "A/B", la carga {"ts": "1970.01.01 AD at 21:46:40 CST"} se envía al bucket de S3:

{
    "ruleArn": "arn:aws:iot:us-east-2:ACCOUNT_ID:rule/RULE_NAME",
    "topicRulePayload": {
        "sql": "SELECT parse_time(\"yyyy.MM.dd G 'at' HH:mm:ss z\", 100000000, 'America/Belize' ) as ts FROM 'A/B'",

        "ruleDisabled": false,
        "awsIotSqlVersion": "2016-03-23",
        "actions": [
            {
                "s3": {
                    "roleArn": "arn:aws:iam::ACCOUNT_ID:rule:role/ROLE_NAME",
                    "bucketName": "BUCKET_NAME",
                    "key": "KEY_NAME"
                }
            }
        ],
        "ruleName": "RULE_NAME"
    }
} 

Cuando este mensaje se publica en el tema "A/B", una carga similar a {"ts": "2017.06.09 AD at 17:19:46 UTC"} (pero con la fecha y hora actuales) se envía al bucket de S3:

{
    "ruleArn": "arn:aws:iot:us-east-2:ACCOUNT_ID:rule/RULE_NAME",
    "topicRulePayload": {
        "sql": "SELECT parse_time(\"yyyy.MM.dd G 'at' HH:mm:ss z\", timestamp() ) as ts FROM 'A/B'",
        "awsIotSqlVersion": "2016-03-23",
        "ruleDisabled": false,
        "actions": [
            {
                "s3": {
                    "roleArn": "arn:aws:iam::ACCOUNT_ID:rule:role/ROLE_NAME",
                    "bucketName": "BUCKET_NAME",
                    "key": "KEY_NAME"
                }
            }
        ],
        "ruleName": "RULE_NAME"
    }
} 

parse_time() se puede usar también como una plantilla de sustitución. Por ejemplo, cuando este mensaje se publica en el tema "A/B", la carga se envía al bucket de S3 con la clave = "2017":

{
    "ruleArn": "arn:aws:iot:us-east-2:ACCOUNT_ID:rule/RULE_NAME",
    "topicRulePayload": {
        "sql": "SELECT * FROM 'A/B'",
        "awsIotSqlVersion": "2016-03-23",
        "ruleDisabled": false,
        "actions": [{
            "s3": {
                "roleArn": "arn:aws:iam::ACCOUNT_ID:rule:role/ROLE_NAME",
                "bucketName": "BUCKET_NAME",
                "key": "${parse_time('yyyy', timestamp(), 'UTC')}"
            }
        }],
        "ruleName": "RULE_NAME"
    }
}

power(Decimal, Decimal)

Devuelve el primer argumento elevado al segundo argumento. Los argumentos Decimal se redondean con doble precisión antes de la aplicación de la función. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: power(2, 5) = 32.0.

principal()

Devuelve la entidad principal que el dispositivo utiliza para la autenticación, en función de cómo se publicó el mensaje de activación. En la siguiente tabla se describe la entidad principal devuelta para cada método y protocolo de publicación.

En los siguientes ejemplos se muestran los distintos tipos de valores que principal() puede devolver:

rand()

Devuelve un valor pseudoaleatorio, distribuido de forma uniforme entre 0,0 y 1,0. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo:

rand() = 0.8231909191640703

regexp_matches(String, String)

Devuelve verdadero si la cadena (primer argumento) contiene una coincidencia para la expresión regular (segundo argumento). Si usa | en la expresión regular, úselo con ().

Ejemplos:

regexp_matches("aaaa", "a{2,}") = true.

regexp_matches("aaaa", "b") = false.

regexp_matches("aaa", "(aaa|bbb)") = true.

regexp_matches("bbb", "(aaa|bbb)") = true.

regexp_matches("ccc", "(aaa|bbb)") = false.

Segundo argumento:

Tiene que ser una expresión regex válida. Los tipos que no son cadenas se convierten en valores de tipo String mediante reglas de conversión estándar. En función del tipo, es posible que la cadena obtenida no sea una expresión regular válida. Si el argumento (convertido) no es un regex válido, el resultado es Undefined.

regexp_replace(String, String, String)

Sustituye todos los segundos argumentos (expresiones regulares) que hay en el primer argumento por el tercer argumento. Hace referencia a los grupos de captura con "$". Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo:

regexp_replace("abcd", "bc", "x") = "axd".

regexp_replace("abcd", "b(.*)d", "$1") = "ac".

Segundo argumento:

Tiene que ser una expresión regex válida. Los tipos que no son cadenas se convierten en valores de tipo String mediante reglas de conversión estándar. En función del tipo, es posible que la cadena obtenida no sea una expresión regular válida. Si el argumento (convertido) no es una expresión regex válida, el resultado es Undefined.

Tercer argumento:

Debe ser una cadena de sustitución de regex válida. (Puede hacer referencia a grupos de capturas). Los tipos que no son cadenas se convierten en valores de tipo String mediante reglas de conversión estándar. Si el argumento (convertido) no es una cadena de sustitución de regex válida, el resultado es Undefined.

regexp_substr(String, String)

Busca la primera coincidencia del segundo parámetro (regex) en el primer parámetro. Hace referencia a los grupos de captura con "$". Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo:

regexp_substr("hihihello", "hi") = "hi"

regexp_substr("hihihello", "(hi)*") = "hihi"

Segundo argumento:

Tiene que ser una expresión regex válida. Los tipos que no son cadenas se convierten en valores de tipo String mediante reglas de conversión estándar. En función del tipo, es posible que la cadena obtenida no sea una expresión regular válida. Si el argumento (convertido) no es una expresión regex válida, el resultado es Undefined.

remainder(Decimal, Decimal)

Devuelve el resto de la división del primer argumento por el segundo argumento. Es igual que mod(Decimal, Decimal). También puede utilizar "%" como un operador infijo para la misma funcionalidad modulo. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: remainder(8, 3) = 2.

replace(Cadena, Cadena, Cadena)

Reemplaza todas las instancias del segundo argumento que hay en el primer argumento por el tercer argumento. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo:

replace("abcd", "bc", "x") = "axd".

replace("abcdabcd", "b", "x") = "axcdaxcd".

rpad(String, Int)

Devuelve el argumento de cadena, rellenado en el lado derecho con el número de espacios especificado en el segundo argumento. El argumento Int debe estar comprendido entre 0 y 1000. Si el valor proporcionado se encuentra fuera de este rango válido, el argumento se establece en el valor válido más cercano (0 o 1000). Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplos:

rpad("hello", 2) = "hello  ".

rpad(1, 3) = "1   ".

round(Decimal)

Redondea el valor Decimal indicado al valor Int más cercano. Si el valor Decimal está a la misma distancia de dos valores Int, (p. ej., 0.5), el valor Decimal se redondea al valor superior. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: Round(1.2) = 1.

Round(1.5) = 2.

Round(1.7) = 2.

Round(-1.1) = -1.

Round(-1.5) = -2.

rtrim(String)

Elimina todos los espacios en blanco del final (tabuladores y espacios) del valor String proporcionado. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplos:

rtrim(" h i ") = " h i"

sign(Decimal)

Devuelve el signo del número especificado. Cuando el signo del argumento es positivo, se devuelve 1. Cuando el signo del argumento es negativo, se devuelve -1. Si el argumento es 0, se devuelve 0. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplos:

sign(-7) = -1.

sign(0) = 0.

sign(13) = 1.

sin(Decimal)

Devuelve el seno de un número en radianes. Los argumentos Decimal se redondean con doble precisión antes de la aplicación de la función. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: sin(0) = 0.0

sinh(Decimal)

Devuelve el seno hiperbólico de un número. Los valores Decimal se redondean con doble precisión antes de la aplicación de la función. El resultado es un valor Decimal de doble precisión. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: sinh(2.3) = 4.936961805545957

sourceip()

Recupera la dirección IP de un dispositivo o del enrutador que se conecta a él. Si el dispositivo está conectado directamente a internet, la función devolverá la dirección IP de origen del dispositivo. Si el dispositivo está conectado a un enrutador que se conecta a internet, la función devolverá la dirección IP de origen del enrutador. Es compatible con la versión SQL 2016-03-23. sourceip() no toma ningún parámetro.

Ejemplos:

sourceip()="192.158.1.38"

sourceip()="1.102.103.104"

sourceip()="2001:db8:ff00::12ab:34cd"

Ejemplo de SQL:

SELECT *, sourceip() as deviceIp FROM 'some/topic'

Ejemplos de cómo utilizar la función sourceip () en las acciones de las AWS IoT Core reglas:

Ejemplo 1

El siguiente ejemplo muestra cómo llamar a la función () como plantilla de sustitución en una acción de DynamoDB.

{
	"topicRulePayload": {
		"sql": "SELECT * AS message FROM 'some/topic'",
		"ruleDisabled": false,
		"awsIotSqlVersion": "2016-03-23",
		"actions": [
			{
				"dynamoDB": {
					"tableName": "my_ddb_table",
					"hashKeyField": "key",
					"hashKeyValue": "${sourceip()}",
					"rangeKeyField": "timestamp",
					"rangeKeyValue": "${timestamp()}",
					"roleArn": "arn:aws:iam::123456789012:role/aws_iot_dynamoDB"
				}
			}
		]
	}
}

Ejemplo 2

El siguiente ejemplo muestra cómo añadir la función sourceip() como propiedad de usuario de MQTT mediante plantillas de sustitución.

{
	"topicRulePayload": {
		"sql": "SELECT * FROM 'some/topic'",
		"ruleDisabled": false,
		"awsIotSqlVersion": "2016-03-23",
		"actions": [
			{
				"republish": {
					"topic": "${topic()}/republish",
					"roleArn": "arn:aws:iam::123456789012:role/aws_iot_republish",
					"headers": {
						"payloadFormatIndicator": "UTF8_DATA",
						"contentType": "rule/contentType",
						"correlationData": "cnVsZSBjb3JyZWxhdGlvbiBkYXRh",
						"userProperties": [
							{
								"key": "ruleKey1",
								"value": "ruleValue1"
							},
							{
								"key": "sourceip",
								"value": "${sourceip()}"
							}
						]
					}
				}
			}
		]
	}
}            

Puede recuperar la dirección IP de origen de los mensajes que se transmiten a AWS IoT Core las reglas desde las rutas Message Broker y Basic Ingest. También puede recuperar la IP de origen de ambos IPv4 IPv6 mensajes. La IP de origen se mostrará de la siguiente manera:

IPv6: yyyy:yyyy:yyyy::yyyy:yyyy

IPv4: xxx.xxx.xxx.xxx

substring(String, Int[, Int])

Espera un valor String seguido de uno o dos valores Int. Para un argumento String y un único argumento Int, esta función devuelve la subcadena del argumento String proporcionado que proviene del índice Int (de base 0 incluido) suministrado al final del argumento String. Para un argumento String y dos argumentos Int, esta función devuelve la subcadena del argumento String proporcionado que proviene del primer argumento de índice Int (de base 0 incluido) en el segundo argumento de índice Int (de base 0 no incluido). Los índices inferiores a cero se establecen en cero. Los índices superiores a la longitud de String se establecen en la longitud de String. Para la versión de tres argumentos, si el primer índice es superior (o igual) al segundo índice, el resultado es el valor String vacío.

 Si los argumentos proporcionados no son (String,Int) o (String,Int,Int), las conversiones estándar se aplican a los argumentos para intentar convertirlos en los tipos correctos. Si no es posible convertirlos, el resultado de la función será Undefined. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplos:

substring("012345", 0) = "012345".

substring("012345", 2) = "2345".

substring("012345", 2.745) = "2345".

substring(123, 2) = "3".

substring("012345", -1) = "012345".

substring(true, 1.2) = "true".

substring(false, -2.411E247) = "false".

substring("012345", 1, 3) = "12".

substring("012345", -50, 50) = "012345".

substring("012345", 3, 1) = "".

sql_version()

Devuelve la versión de SQL especificada en esta regla. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo:

sql_version() = "2016-03-23"

sqrt(Decimal)

Devuelve la raíz cuadrada de un número. Los argumentos Decimal se redondean con doble precisión antes de la aplicación de la función. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: sqrt(9) = 3,0.

startswith(String, String)

Devuelve Boolean, si el primer argumento de cadena comienza con el segundo argumento de cadena. Si alguno de los argumentos es Null o Undefined, el resultado es Undefined. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo:

startswith("ranger","ran") = true

tan(Decimal)

Devuelve la tangente de un número en radianes. Los valores Decimal se redondean con doble precisión antes de la aplicación de la función. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: tan(3) = -0.1425465430742778

tanh(Decimal)

Devuelve la tangente hiperbólica de un número en radianes. Los valores Decimal se redondean con doble precisión antes de la aplicación de la función. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: tanh(2.3) = 0.9800963962661914

time_to_epoch(String, String)

Utilice la función time_to_epoch para convertir una cadena de marca temporal en un número de milisegundos en el formato de tiempo Unix. Es compatible con la versión SQL 2016-03-23 y versiones posteriores. Para convertir milisegundos en una cadena de marca temporal formateada, consulte parse_time(String, Long[, String]).

La función time_to_epoch espera los argumentos siguientes:

Ejemplos:

time_to_epoch("2020-04-03 09:45:18 UTC+01:00", "yyyy-MM-dd HH:mm:ss VV")= 1585903518000

time_to_epoch("18 December 2015", "dd MMMM yyyy")= 1450396800000

time_to_epoch("2007-12-03 10:15:30.592 America/Los_Angeles", "yyyy-MM-dd HH:mm:ss.SSS z")= 1196705730592

timestamp()

Devuelve la marca de tiempo actual en segundos a partir de las 00:00:00 (hora universal coordinada) del jueves 1 de enero de 1970, según el motor de reglas. AWS IoT Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo: timestamp() = 1481825251155

topic(Decimal)

Devuelve el tema al que se ha enviado el mensaje que activó la regla. Si no se especifica ningún parámetro, se devuelve todo el tema. El parámetro Decimal se utiliza para especificar un segmento de tema concreto. 1 designa el primer segmento. Para el tema foo/bar/baz, topic(1) devuelve foo, topic(2) devuelve bar y así sucesivamente. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplos:

topic() = "things/myThings/thingOne"

topic(1) = "things"

Cuando se usa Basic Ingest, el prefijo inicial del tema ($aws/rules/rule-name) no está disponible para la función topic(). Por ejemplo, con el tema:

$aws/rules/BuildingManager/Buildings/Building5/Floor2/Room201/Lights

topic() = "Buildings/Building5/Floor2/Room201/Lights"

topic(3) = "Floor2"

traceid()

Devuelve el ID de seguimiento (UUID) del mensaje MQTT o Undefined si el mensaje no se ha enviado por MQTT. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo:

traceid() = "12345678-1234-1234-1234-123456789012"

transform(String, Object, Array)

Devuelve una matriz de objetos que contiene el resultado de la transformación especificada del parámetro Object en el parámetro Array.

Es compatible con la versión SQL 2016-03-23 y versiones posteriores.

Ejemplo 1 de la función de transformación

En este ejemplo se muestra cómo la función transform() produce una matriz única de objetos a partir de un objeto de datos y una matriz.

En este ejemplo, se publica el siguiente mensaje en el tema A/B de MQTT.

{
    "attributes": {
        "data1": 1,
        "data2": 2
    },
    "values": [
        {
            "a": 3
        },
        {
            "b": 4
        },
        {
            "c": 5
        }
    ]
}

Esta instrucción SQL para una acción de regla temática utiliza la función transform() con un valor de String de enrichArray. En este ejemplo, Object es la propiedad attributes de la carga del mensaje y Array es la matriz values, que contiene tres objetos.

select value transform("enrichArray", attributes, values) from 'A/B'

Al recibir la carga del mensaje, la instrucción SQL se evalúa en la siguiente respuesta.

[
  {
    "a": 3,
    "data1": 1,
    "data2": 2
  },
  {
    "b": 4,
    "data1": 1,
    "data2": 2
  },
  {
    "c": 5,
    "data1": 1,
    "data2": 2
  }
]

Ejemplo 2 de la función de transformación

En este ejemplo se muestra cómo la función transform() puede usar valores literales para incluir y cambiar el nombre de los atributos individuales de la carga del mensaje.

En este ejemplo, se publica el siguiente mensaje en el tema A/B de MQTT. Es el mismo mensaje que se usó en Ejemplo 1 de la función de transformación.

{
    "attributes": {
        "data1": 1,
        "data2": 2
    },
    "values": [
        {
            "a": 3
        },
        {
            "b": 4
        },
        {
            "c": 5
        }
    ]
}

Esta instrucción SQL para una acción de regla temática utiliza la función transform() con un valor de String de enrichArray. El Object de la función transform() tiene un único atributo llamado key con el valor de attributes.data1 en la carga del mensaje y Array es la matriz values, que contiene los mismos tres objetos utilizados en el ejemplo anterior.

select value transform("enrichArray", {"key": attributes.data1}, values) from 'A/B'

Al recibir la carga del mensaje, esta instrucción SQL se evalúa en la siguiente respuesta. Observe cómo la propiedad data1 se nombra key en la respuesta.

[
  {
    "a": 3,
    "key": 1
  },
  {
    "b": 4,
    "key": 1
  },
  {
    "c": 5,
    "key": 1
  }
]

Ejemplo 3 de la función de transformación

En este ejemplo se muestra cómo se puede utilizar la función transform() en las cláusulas SELECT anidadas para seleccionar varios atributos y crear nuevos objetos para su posterior procesamiento.

En este ejemplo, se publica el siguiente mensaje en el tema A/B de MQTT.

{
  "data1": "example",
  "data2": {
    "a": "first attribute",
    "b": "second attribute",
    "c": [
      {
        "x": {
          "someInt": 5,
          "someString": "hello"
        },
        "y": true
      },
      {
        "x": {
          "someInt": 10,
          "someString": "world"
        },
        "y": false
      }
    ]
  }
}

El Object para esta función de transformación es el objeto devuelto por la instrucción SELECT, que contiene los elementos a y b de la cosa data2 del mensaje. El parámetro Array consta de los dos objetos de la matriz data2.c del mensaje original.

select value transform('enrichArray', (select a, b from data2), (select value c from data2)) from 'A/B'

Con el mensaje anterior, la instrucción SQL se evalúa en la siguiente respuesta.

[
  {
    "x": {
      "someInt": 5,
      "someString": "hello"
    },
    "y": true,
    "a": "first attribute",
    "b": "second attribute"
  },
  {
    "x": {
      "someInt": 10,
      "someString": "world"
    },
    "y": false,
    "a": "first attribute",
    "b": "second attribute"
  }
]

La matriz devuelta en esta respuesta podría usarse con las acciones de la regla temática compatibles con batchMode.

trim(String)

Elimina todos los espacios en blanco del principio y del final del valor String proporcionado. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplo:

Trim(" hi ") = "hi"

trunc(Decimal, Int)

Trunca el primer argumento según el número del valor Decimal especificado por el segundo argumento. Si el segundo argumento es inferior a cero, se establece en cero. Si el segundo argumento es superior a 34, se establece en 34. Los ceros del final se eliminan del resultado. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplos:

trunc(2.3, 0) = 2.

trunc(2.3123, 2) = 2.31.

trunc(2.888, 2) = 2,88.

trunc(2.00, 5) = 2.

upper(String)

Muestra la versión en mayúsculas del valor String indicado. Los argumentos que no sean String se convierten en String mediante las reglas de conversión estándar. Es compatible con la versión 2015-10-08 de SQL y versiones posteriores.

Ejemplos:

upper("hello") = "HELLO"

upper(["hello"]) = "[\"HELLO\"]"