com.couchbase.columnar.client.java.QueryException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of couchbase-columnar-java-client Show documentation

The official Couchbase Columnar Java SDK

The newest version!

/*
 * Copyright 2024 Couchbase, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.couchbase.columnar.client.java;

import com.couchbase.client.core.cnc.Context;
import com.couchbase.client.core.error.ErrorCodeAndMessage;
import com.couchbase.client.core.error.context.ErrorContext;

import static java.util.Objects.requireNonNull;

/**
 * Thrown when the Columnar cluster returns an error message in response to a query request.
 */
public class QueryException extends ColumnarException {
  private final ErrorCodeAndMessage errorCodeAndMessage;

  QueryException(
    ErrorCodeAndMessage errorCodeAndMessage,
    ErrorContext ctx
  ) {
    super(errorCodeAndMessage + " ; " + ctx.exportAsString(Context.ExportFormat.JSON));
    this.errorCodeAndMessage = requireNonNull(errorCodeAndMessage);
  }

  /**
   * Returns the Columnar error code sent by the server.
   */
  // todo include a documentation reference link in the Javadoc
  public int code() {
    return errorCodeAndMessage.code();
  }

  /**
   * Returns the human-readable error message sent by the server, without
   * the additional context returned by {@link #getMessage()}.
   * 
   * Caveat: The content and structure of this message may change
   * between Couchbase Server versions.
   */
  public String serverMessage() {
    return errorCodeAndMessage.message();
  }
}