diff --git a/ReleaseNotes/eng/Altibase_DataAPI_1_0_0_Release_Notes.md b/ReleaseNotes/eng/Altibase_DataAPI_1_0_0_Release_Notes.md new file mode 100644 index 000000000..4b179e719 --- /dev/null +++ b/ReleaseNotes/eng/Altibase_DataAPI_1_0_0_Release_Notes.md @@ -0,0 +1,93 @@ + + + + + + +- [Altibase DataAPI 1.0.0 Release Notes](#altibase-dataapi-100-release-notes) + - [1. Overview](#1-overview) + - [2. Key Features](#2-key-features) + - [Support for JWT Bearer Authentication and Basic Authentication](#support-for-jwt-bearer-authentication-and-basic-authentication) + - [Core HTTP Endpoints](#core-http-endpoints) + - [JSON-based Requests and Responses](#json-based-requests-and-responses) + - [NDJSON Streaming Support](#ndjson-streaming-support) + - [Dynamic Per-user Connection Pool Management](#dynamic-per-user-connection-pool-management) + - [Operation and Monitoring Support](#operation-and-monitoring-support) + - [3. Compatibility](#3-compatibility) + - [4. Download](#4-download) + - [Packages](#packages) + - [Docker Images](#docker-images) + - [Manual](#manual) + + + +
+ +
+ +
+ +Altibase DataAPI 1.0.0 Release Notes +=============================== + +**(July 1, 2026)** + +## 1. Overview + +The Altibase Data API is a Spring Boot–based service that provides Altibase SQL execution and query capabilities over HTTP APIs. Clients can perform SQL queries, execute DML/DDL statements, and leverage streaming for bulk data retrieval via either DB user authentication or JWT token–based authentication. Additionally, it offers a monitoring API to query connection pool status and metric information for the Data API. + +## 2. Key Features + +### Support for JWT Bearer Authentication and Basic Authentication + +JWT Bearer authentication supports token-based session management and authentication flow control. Basic authentication verifies credentials for every request without additional token management and is suitable for scripts, batch jobs, and monitoring environments. + +### Core HTTP Endpoints + +Provides endpoints required for SQL execution, result retrieval, large-volume streaming, authentication, and session management. For the detailed list, refer to the manual. + +### JSON-based Requests and Responses + +Requests are sent in JSON format containing SQL text and bind values, and query results are returned in JSON format. + +### NDJSON Streaming Support + +Large query results can be transmitted sequentially in NDJSON (Newline Delimited JSON) format, and memory usage is minimized through lazy-execution-based streaming. + +### Dynamic Per-user Connection Pool Management + +Creates and reuses user-specific connection pools, ensuring safe cleanup upon session termination for efficient resource management. + +### Operation and Monitoring Support + +Provides APIs for retrieving connection pool status and metrics, as well as Prometheus-compatible metrics. + + + +## 3. Compatibility + +- Compatible with Java 17 or later. +- Available for Altibase 7.1.0.5.6 or later. + + + +## 4. Download + +### Packages + +The Data API packages are provided as the following files and can be downloaded from http://support.altibase.com/kr/product. + +* data-api-1.0.0-altibase8.jar +* data-api-1.0.0-altibase7.jar + +### Docker Images + +The Data API Docker images are provided with the following tags. + +- altibase/data-api:1.0.0 +- altibase/data-api:1.0.0-altibase7 +- altibase/data-api:latest + +### Manual + +- [Data API Manual - Altibase 8.1 Manual](https://manual.altibase.com/8.1/dev/data-api/copyright/) diff --git a/ReleaseNotes/kor/Altibase_DataAPI_1_0_0_Release_Notes.md b/ReleaseNotes/kor/Altibase_DataAPI_1_0_0_Release_Notes.md new file mode 100644 index 000000000..800ce9dda --- /dev/null +++ b/ReleaseNotes/kor/Altibase_DataAPI_1_0_0_Release_Notes.md @@ -0,0 +1,93 @@ + + + + + + +- [Altibase DataAPI 1.0.0 Release Notes](#altibase-dataapi-100-release-notes) + - [1. 개요](#1-%EA%B0%9C%EC%9A%94) + - [2. 주요 특징](#2-%EC%A3%BC%EC%9A%94-%ED%8A%B9%EC%A7%95) + - [JWT Bearer 인증 및 Basic 인증 지원](#jwt-bearer-%EC%9D%B8%EC%A6%9D-%EB%B0%8F-basic-%EC%9D%B8%EC%A6%9D-%EC%A7%80%EC%9B%90) + - [주요 HTTP 엔드포인트 제공](#%EC%A3%BC%EC%9A%94-http-%EC%97%94%EB%93%9C%ED%8F%AC%EC%9D%B8%ED%8A%B8-%EC%A0%9C%EA%B3%B5) + - [JSON 기반 요청 및 응답](#json-%EA%B8%B0%EB%B0%98-%EC%9A%94%EC%B2%AD-%EB%B0%8F-%EC%9D%91%EB%8B%B5) + - [NDJSON 스트리밍 지원](#ndjson-%EC%8A%A4%ED%8A%B8%EB%A6%AC%EB%B0%8D-%EC%A7%80%EC%9B%90) + - [동적 사용자별 커넥션 풀 관리](#%EB%8F%99%EC%A0%81-%EC%82%AC%EC%9A%A9%EC%9E%90%EB%B3%84-%EC%BB%A4%EB%84%A5%EC%85%98-%ED%92%80-%EA%B4%80%EB%A6%AC) + - [운영 및 모니터링 지원](#%EC%9A%B4%EC%98%81-%EB%B0%8F-%EB%AA%A8%EB%8B%88%ED%84%B0%EB%A7%81-%EC%A7%80%EC%9B%90) + - [3. 호환성](#3-%ED%98%B8%ED%99%98%EC%84%B1) + - [4. 다운로드](#4-%EB%8B%A4%EC%9A%B4%EB%A1%9C%EB%93%9C) + - [패키지](#%ED%8C%A8%ED%82%A4%EC%A7%80) + - [도커 이미지](#%EB%8F%84%EC%BB%A4-%EC%9D%B4%EB%AF%B8%EC%A7%80) + - [매뉴얼](#%EB%A7%A4%EB%89%B4%EC%96%BC) + + + +
+ +
+ +
+ +Altibase DataAPI 1.0.0 Release Notes +=============================== + +**(July 1, 2026)** + +## 1. 개요 + +Altibase Data API는 Altibase SQL 실행 및 조회 기능을 HTTP API로 제공하는 Spring Boot 기반 서비스입니다. 클라이언트는 DB 사용자 인증 또는 JWT 토큰 기반 인증을 통해 SQL 조회, DML/DDL 실행, 대량 데이터 조회를 위한 스트리밍 기능을 사용할 수 있으며, Data API의 커넥션 풀 상태와 메트릭 정보를 조회할 수 있는 모니터링 API를 제공합니다. + +## 2. 주요 특징 + +### JWT Bearer 인증 및 Basic 인증 지원 + +JWT Bearer 인증은 토큰 기반 세션 유지와 인증 흐름 제어를 지원하며, Basic 인증은 별도 토큰 관리 없이 매 요청마다 자격증명을 검증하여 스크립트·배치·모니터링 환경에 적합합니다. + +### 주요 HTTP 엔드포인트 제공 + +SQL 실행, 결과 조회, 대용량 스트리밍, 인증 및 세션 관리에 필요한 엔드포인트를 제공합니다. 자세한 목록은 [**엔드포인트 요약**]([부록 A. 엔드포인트 요약 - Altibase 8.1 매뉴얼](https://manual.altibase.com/8.1/dev/data-api/Appendix-A.-API-Reference/))을 참조합니다. + +### JSON 기반 요청 및 응답 + +요청은 SQL 텍스트와 바인드 값을 포함한 JSON 형식으로 전달되며, 조회 결과는 JSON 형식으로 반환됩니다. + +### NDJSON 스트리밍 지원 + +대량 조회 결과를 NDJSON(Newline Delimited JSON) 형식으로 순차 전송할 수 있으며, 지연 실행 기반 스트리밍을 통해 메모리 사용량을 최소화합니다. + +### 동적 사용자별 커넥션 풀 관리 + +사용자별 커넥션 풀을 생성 및 재사용하고, 세션 종료 시 안전하게 정리하여 리소스를 효율적으로 관리합니다. + +### 운영 및 모니터링 지원 + +커넥션 풀 상태와 메트릭 정보를 조회할 수 있으며, Prometheus 수집용 메트릭을 제공합니다. + + + +## 3. 호환성 + +- Java 17 이상에서 호환됩니다. +- Altibase 7.1.0.5.6 이상에서 사용할 수 있습니다. + + + +## 4. 다운로드 + +### 패키지 + +Data API 패키지는 아래의 파일로 제공되며, http://support.altibase.com/kr/product 에서 다운로드 받을 수 있습니다. + +* data-api-1.0.0-altibase8.jar +* data-api-1.0.0-altibase7.jar + +### 도커 이미지 + +Data API Docker 이미지는 다음 태그로 제공됩니다. + +- altibase/data-api:1.0.0 +- altibase/data-api:1.0.0-altibase7 +- altibase/data-api:latest + +### 매뉴얼 + +- [Data API Manual - Altibase 8.1 매뉴얼](https://manual.altibase.com/8.1/dev/data-api/copyright/)