En este notebook aparece la documentación relativa al grupo de intérpretes %onesaitplatform de Apache Zeppelin. En este documento se detallan las funcionalidades de los intérpretes del grupo.
Contenidos
%onesaitplatform
Este intérprete dispone de funcionalidades de comunicación con el módulo IoT-Broker, que se utiliza para consultar e insertar datos en ontologías.
| Funcionalidad | Sintaxis | Ejemplo | Descripción |
|---|---|---|---|
| Mostrar la ayuda | help | help | Muestra la ayuda del intérprete |
| Modo debug | setDebugMode(<true / false>) | setDebugMode(true) | Habilita el modo debug para mostrar la traza de debug |
| Iniciar conexión | initConnection("<iot_client>", "<iot_client_token>") | initConnection("ExampleClient", "674a6e03348a418787e5af4hcdf5b3df") | Inicia la conexión con el IoT-Broker mediante un Digital Client autorizado |
| Consulta de datos SQL | select * from <ontology> (SQL) | select * from Restaurants limit 3 | Consulta de datos con sintaxis SQL |
| Consulta de datos NATIVE | db.<ontology>.find(); (MongoDB) | db.Restaurants.find().limit(3) | Consulta de datos con sintaxis MongoDB |
| Consulta de datos como zeppelin table | asZTable(<query>) | asZTable(select c.Restaurant.borough, c.Restaurant.grades[0].score from Restaurants AS c) | Consulta de datos con formato zeppelin table desde una consulta |
| Introducir valores en contexto | z.put("<key>", <query>) | z.put("testZ", select * from Restaurants limit 1) | Guarda los resultados de una consulta en una variable de contexto |
| Recuperar valores desde contexto | z.get("<key>") | z.get("testZ") | Recupera los datos de una variable del contexto |
| Insertar valores en ontología | insert("<ontology>", z.get("<key>")) | insert("Restaurants",z.get("testZ")) | Inserta los valores en una ontología |
| Consultas con paginación | paginatedQuery(<query>) | z.put("paginated_query", paginatedQuery(select * from Restaurants)) | Realiza las peticiones en batches configurables desde el gestor de intérpretes |
%onesaitplatform.apimanager
Este intérprete dispone de funcionalidades de comunicación con el módulo Api Manager, que se utiliza para gestionar y utilizar las APIs REST de la plataforma.
| Funcionalidad | Sintaxis | Ejemplo | Descripción |
|---|---|---|---|
| Mostrar la ayuda | help | help | Muestra la ayuda del intérprete |
| Modo debug | setDebugMode(<true / false>) | setDebugMode(true) | Habilita el modo debug para mostrar la traza de debug |
| Set token | setToken("<user_token>") | setToken("07619411b8b68fe4942c2kb0344a72d5") | Establece el token de usuario necesario para las llamadas |
| Listar APIs de usuario | listAPIS("<user>") | listAPIS("usuario") | Lista la información básica de las APIs del usuario <usuario> |
| Introducir valores en contexto | z.put("<key>", <data>) | z.put("apis_usuario", listAPIS("usuario")) | Guarda un conjunto de datos en una variable de contexto |
| Recuperar valores desde contexto | z.get("<key>") | z.get("apis_usuario")[0] | Recupera los datos de una variable del contexto |
| Buscar información de una API | findAPI("<api_name>", "<api_status>", "<user>") | findAPI("ExampleAPI", "Development", "usuario") | Recupera la información detallada de un API |
| Llamar a una API | callAPI("<api_path>", "<method>", "<body>") | z.put("test_Call", callAPI("v1/exampleAPI", "GET", "null")) | Realiza una llamada a una API de la plataforma |
Para ver un ejemplo de uso de los intérpretes, consultar (Notebooks) (ES) Cómo utilizar los intérpretes %onesaitplatform.