Package com.altibase.document.api

Interface InsertResult

All Superinterfaces:
UpdateResult
All Known Implementing Classes:
InsertResultImpl, InsertResultImpl
public interface InsertResult extends UpdateResult
문서 삽입(insert) 연산의 결과를 나타내는 인터페이스이다.

UpdateResult를 상속받아 삽입된 문서의 개수를 제공하며, 추가적으로 삽입된 문서의 **키(Key) 값**에 접근하는 기능을 제공한다. 이 인터페이스의 인스턴스는 AltibaseCollection.insertOne(AltibaseDocument) 또는 AltibaseCollection.insertMany(List) 메서드를 통해 반환된다.

주요 특징

  • 키 값 접근: getKeyValue()를 통해 삽입된 키를 Object로 받거나, getStringKey() 등 타입별 메서드로 안전하게 받을 수 있다.
  • 삽입 개수 확인: 상속받은 getAffectedCount()를 통해 몇 개의 문서가 삽입되었는지 확인할 수 있다.(보통 1)

사용 예제


 AltibaseDocument doc = booksCollection.createDocument("{\"title\":\"Fahrenheit 451\"}");
 InsertResult result = booksCollection.insertOne(doc);

 System.out.println("삽입된 문서 수: " + result.getAffectedCount());

 // 키 생성 방식이 UUID인 경우, 생성된 키를 결과로부터 얻을 수 있다.
 String generatedKey = result.getStringKey();
 System.out.println("삽입된 문서의 키: " + generatedKey);
Since:
1.0
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    default Integer
    getIntegerKey()
    삽입된 문서의 키 값을 Integer 타입으로 안전하게 반환한다.
    Class<?>
    getKeyType()
    삽입된 문서의 키에 해당하는 자바 Class 타입을 반환한다.
    Object
    getKeyValue()
    삽입된 문서의 키 값을 Object 타입으로 반환한다.
    default Long
    getLongKey()
    삽입된 문서의 키 값을 Long 타입으로 안전하게 반환한다.
    default Short
    getShortKey()
    삽입된 문서의 키 값을 Short 타입으로 안전하게 반환한다.
    default String
    getStringKey()
    삽입된 문서의 키 값을 String 타입으로 안전하게 반환한다.

    Methods inherited from interface com.altibase.document.api.UpdateResult

    getAffectedDocCount

  • Method Details

    • getKeyValue

      Object getKeyValue()
      삽입된 문서의 키 값을 Object 타입으로 반환한다.

      반환된 값은 실제 키 타입에 맞게 캐스팅하여 사용해야 한다. 타입 안전성이 필요하다면 getIntegerKey(), getStringKey() 등 타입별 편의 메서드 사용을 권장한다.

      Returns:
      키 값 (Object 타입)

    • getKeyType

      Class<?> getKeyType()
      삽입된 문서의 키에 해당하는 자바 Class 타입을 반환한다.

      이 정보는 타입별 편의 메서드 내부에서 타입 검증을 위해 사용된다.

      Returns:
      키의 Class 타입

    • getIntegerKey

      default Integer getIntegerKey()
      삽입된 문서의 키 값을 Integer 타입으로 안전하게 반환한다.

      내부적으로 키 타입이 실제 Integer인지 검증한 후 값을 반환한다.

      Returns:
      Integer 타입 키 값
      Throws:
      AltibaseCollectionException - 키 타입이 Integer가 아닐 경우

    • getStringKey

      default String getStringKey()
      삽입된 문서의 키 값을 String 타입으로 안전하게 반환한다.

      내부적으로 키 타입이 실제 String인지 검증한 후 값을 반환한다.

      Returns:
      String 타입 키 값
      Throws:
      AltibaseCollectionException - 키 타입이 String이 아닐 경우

    • getLongKey

      default Long getLongKey()
      삽입된 문서의 키 값을 Long 타입으로 안전하게 반환한다.

      내부적으로 키 타입이 실제 Long인지 검증한 후 값을 반환한다.

      Returns:
      Long 타입 키 값
      Throws:
      AltibaseCollectionException - 키 타입이 Long이 아닐 경우

    • getShortKey

      default Short getShortKey()
      삽입된 문서의 키 값을 Short 타입으로 안전하게 반환한다.

      내부적으로 키 타입이 실제 Short인지 검증한 후 값을 반환한다.

      Returns:
      Short 타입 키 값
      Throws:
      AltibaseCollectionException - 키 타입이 Short가 아닐 경우