Oracle REST Data Services Generator

Extensión para Visual Studio Code diseñada para gestionar y generar scripts PL/SQL de Oracle REST Data Services (ORDS) directamente desde tu editor. Replica la experiencia del árbol de "REST Data Services" de SQL Developer, permitiéndote explorar, crear, editar y eliminar módulos, plantillas y métodos de forma rápida y directa.

Características Principales

• Explorador Integrado: Visualiza tus servicios REST en un árbol jerárquico (Módulo → Plantilla → Métodos) directamente en la barra lateral de VS Code.
• Edición Unificada: Interfaz directa e integrada que permite crear o modificar módulos, plantillas y manejadores (GET, POST, PUT, DELETE) sin tener que escribir o recordar la sintaxis de los paquetes PL/SQL (ORDS.DEFINE_MODULE, ORDS.DEFINE_TEMPLATE, etc.) a mano.
• Edición en VS Code con Autocompletado (IntelliSense): Botón "Editar en VS Code" que abre una pestaña de editor SQL nativo lado a lado con sincronización en tiempo real. Te permite aprovechar el autocompletado inteligente de base de datos (tablas, columnas, esquemas) de la extensión oficial de Oracle SQL Developer.
• Validación Inteligente de Parámetros: Validación automática que verifica si todos los parámetros definidos en la ruta (p_pattern) y en la pestaña de parámetros del método están referenciados como variables de enlace (ej: :id) dentro del script SQL/PL-SQL antes de guardar o aplicar.
• Eliminación Directa y Segura: Al borrar una plantilla o un método específico, genera y muestra un script de redefinición dinámico y compatible para conservar el resto de la configuración del módulo intacta.
• Auto-escapado de Comillas: Pega tus consultas SQL tal cual las probaste; la extensión se encarga de escapar las comillas simples automáticamente al generar el PL/SQL.

Requisitos

• Esta extensión requiere que tengas instalada y configurada la extensión oficial Oracle SQL Developer Extension for VS Code.
• Utiliza las conexiones a bases de datos Oracle definidas en esa extensión para consultar el árbol de ORDS y aplicar los cambios.

Uso

1. Explorar el Árbol de ORDS

Selecciona una conexión a tu base de datos y abre la vista de Oracle REST Data Services en la barra de actividad (Activity Bar). Verás desplegado tu árbol actual de servicios. En la parte superior del panel, encontrarás botones para Seleccionar conexión y Refrescar árbol.

2. Crear Nuevos Servicios

• Nuevo Módulo: Haz clic en el icono + (Nuevo módulo) en la parte superior del panel del árbol de ORDS. Esto abrirá el editor para que configures el nombre, ruta base y otros atributos.
• Nueva Plantilla: Haz clic derecho sobre un Módulo existente y elige Agregar Plantilla. El panel te permitirá ingresar el nombre (p_pattern) y configurar prioridades o comentarios.
• Nuevo Manejador: Haz clic derecho sobre una Plantilla existente y elige Agregar Manejador. (Nota: El editor consultará la base de datos para detectar qué métodos HTTP ya están en uso y deshabilitará aquellos que ya existan para evitar duplicados).

3. Editar Elementos Existentes y Edición en VS Code

Haz clic derecho sobre cualquier Módulo, Plantilla o Método en el árbol y selecciona Editar.

• Los datos se cargarán en la interfaz interactiva. Podrás configurar rutas, comentarios, tipos de origen (p_source_type), y escribir tu consulta SQL o bloque PL/SQL.
• Edición Avanzada con VS Code: Junto a la etiqueta de código del método, encontrarás el botón ✏️ Editar en VS Code. Al hacer clic:
  • Se abrirá un editor SQL nativo de VS Code al lado del formulario en una carpeta oculta .ords_temp/.
  • Sincronización en tiempo real: Cualquier cosa que escribas en el editor SQL se reflejará instantáneamente en el formulario del Webview y en la vista previa del script consolidado.
  • Autocompletado Inteligente: Al abrirse, la extensión disparará de forma automática el diálogo de conexión de la extensión Oracle SQL Developer para que selecciones tu base de datos y actives la detección de sintaxis e IntelliSense inteligente sobre tus tablas y columnas.
  • Seguridad ante descartes: Si cierras la pestaña SQL sin guardar o la descartas, el Webview conservará de forma segura el último texto que habías redactado para evitar pérdidas accidentales.
• Los métodos HTTP organizan sus parámetros, tipos y consultas a través de un sistema de pestañas internas (Query, Config, Parámetros), permitiendo un área de trabajo ordenada.
• Presiona Aplicar Script para ejecutar los cambios directamente sobre la conexión activa de base de datos, o Guardar script para exportarlo a un archivo.

4. Eliminar Elementos

Haz clic derecho sobre cualquier nodo en el árbol de ORDS y selecciona Eliminar.

• La extensión cargará el contexto y te mostrará el script exacto de eliminación generado.
• Al eliminar un módulo o plantilla, se aplica una baja directa compatible. Al eliminar un manejador individual, el script redefinirá la plantilla de forma transparente conservando los otros métodos.
• Revisa el código y haz clic en Eliminar para aplicar los cambios a la base de datos de manera definitiva.

5. Exportar Todo

Haz clic en el icono de descarga (Exportar todo) en la parte superior del panel del árbol de ORDS.

• Esta función generará y exportará un script SQL con todos los módulos, plantillas y manejadores de la conexión actual.

6. Validación de Parámetros

Al intentar aplicar o guardar cambios de una plantilla o método:

• La extensión comprueba que todos los parámetros del patrón de la plantilla (p_pattern) y los configurados en la pestaña Parámetros del método existan en la consulta SQL (antecedidos por el carácter :; ejemplo: :id).
• Si faltan, el sistema deshabilitará los botones de guardar/aplicar y mostrará una advertencia clara con los parámetros omitidos para evitar fallos de ejecución en base de datos.

Acerca del Proyecto

Esta herramienta está pensada para agilizar drásticamente el flujo de desarrollo de APIs REST sobre Oracle Database, ahorrándote el trabajo tedioso y repetitivo de formatear cadenas de texto o lidiar con las limitaciones de algunas versiones antiguas de ORDS. También evita tener que salir de VS Code para poder crear nuevas APIs REST.

Desarrollado para simplificar la vida de los desarrolladores en bases de datos Oracle.