QueryApi

All URIs are relative to /v1

Method	HTTP request	Description
finalizeQuery	POST /arrays/{namespace}/{array}/query/finalize
getEstResultSizes	POST /arrays/{namespace}/{array}/query/est_result_sizes
getFile	GET /arrays/{namespace}/{array}/query/get_file
submitQuery	POST /arrays/{namespace}/{array}/query/submit
submitQueryJson	POST /arrays/{namespace}/{array}/query/submit_query_json

finalizeQuery

Query finalizeQuery(namespace, array, type, contentType, query, xPayer, openAt)

send a query to run against a specified array/URI registered to a group/project

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.QueryApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    QueryApi apiInstance = new QueryApi(defaultClient);
    String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
    String array = "array_example"; // String | name/uri of array that is url-encoded
    String type = "type_example"; // String | type of query
    String contentType = "application/json"; // String | Content Type of input and return mime
    Query query = new Query(); // Query | query to run
    String xPayer = "xPayer_example"; // String | Name of organization or user who should be charged for this request
    Integer openAt = 56; // Integer | open_at for array in unix epoch
    try {
      Query result = apiInstance.finalizeQuery(namespace, array, type, contentType, query, xPayer, openAt);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling QueryApi#finalizeQuery");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
namespace	String	namespace array is in (an organization name or user's username)
array	String	name/uri of array that is url-encoded
type	String	type of query
contentType	String	Content Type of input and return mime	[default to application/json]
query	Query	query to run
xPayer	String	Name of organization or user who should be charged for this request	[optional]
openAt	Integer	open_at for array in unix epoch	[optional]

Return type

Query

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json, application/capnp
Accept: application/json, application/capnp

HTTP response details

Status code	Description	Response headers
200	query completed and results are returned in query object	* X-TILEDB-CLOUD-TASK-ID - Task ID for just completed request
204	query completed successfully with no return	-
502	Bad Gateway	-
0	error response	-

getEstResultSizes

Query getEstResultSizes(namespace, array, type, contentType, query, xPayer, openAt)

send a query to run against a specified array/URI registered to a group/project

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.QueryApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    QueryApi apiInstance = new QueryApi(defaultClient);
    String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
    String array = "array_example"; // String | name/uri of array that is url-encoded
    String type = "type_example"; // String | type of query
    String contentType = "application/json"; // String | Content Type of input and return mime
    Query query = new Query(); // Query | query to run
    String xPayer = "xPayer_example"; // String | Name of organization or user who should be charged for this request
    Integer openAt = 56; // Integer | open_at for array in unix epoch
    try {
      Query result = apiInstance.getEstResultSizes(namespace, array, type, contentType, query, xPayer, openAt);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling QueryApi#getEstResultSizes");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
namespace	String	namespace array is in (an organization name or user's username)
array	String	name/uri of array that is url-encoded
type	String	type of query
contentType	String	Content Type of input and return mime	[default to application/json]
query	Query	query to run
xPayer	String	Name of organization or user who should be charged for this request	[optional]
openAt	Integer	open_at for array in unix epoch	[optional]

Return type

Query

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json, application/capnp
Accept: application/json, application/capnp

HTTP response details

Status code	Description	Response headers
200	query est result size computed and results are returned in query object	* X-TILEDB-CLOUD-TASK-ID - Task ID for just completed request
204	query completed successfully with no return	-
502	Bad Gateway	-
0	error response	-

getFile

File getFile(namespace, array, contentType, xPayer)

send a query to run against a specified array/URI registered to a group/project, returns file bytes

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.QueryApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    QueryApi apiInstance = new QueryApi(defaultClient);
    String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
    String array = "array_example"; // String | name/uri of array that is url-encoded
    String contentType = "application/json"; // String | Content Type of input and return mime
    String xPayer = "xPayer_example"; // String | Name of organization or user who should be charged for this request
    try {
      File result = apiInstance.getFile(namespace, array, contentType, xPayer);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling QueryApi#getFile");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
namespace	String	namespace array is in (an organization name or user's username)
array	String	name/uri of array that is url-encoded
contentType	String	Content Type of input and return mime	[default to application/json]
xPayer	String	Name of organization or user who should be charged for this request	[optional]

Return type

File

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: Not defined
Accept: application/x-ipynb+json

HTTP response details

Status code	Description	Response headers
200	query completed and result bytes are returned	* X-TILEDB-CLOUD-TASK-ID - Task ID for just completed request
502	Bad Gateway	-
0	error response	-

submitQuery

Query submitQuery(namespace, array, type, contentType, query, xPayer, openAt)

send a query to run against a specified array/URI registered to a group/project

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.QueryApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    QueryApi apiInstance = new QueryApi(defaultClient);
    String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
    String array = "array_example"; // String | name/uri of array that is url-encoded
    String type = "type_example"; // String | type of query
    String contentType = "application/json"; // String | Content Type of input and return mime
    Query query = new Query(); // Query | query to run
    String xPayer = "xPayer_example"; // String | Name of organization or user who should be charged for this request
    Integer openAt = 56; // Integer | open_at for array in unix epoch
    try {
      Query result = apiInstance.submitQuery(namespace, array, type, contentType, query, xPayer, openAt);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling QueryApi#submitQuery");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
namespace	String	namespace array is in (an organization name or user's username)
array	String	name/uri of array that is url-encoded
type	String	type of query
contentType	String	Content Type of input and return mime	[default to application/json]
query	Query	query to run
xPayer	String	Name of organization or user who should be charged for this request	[optional]
openAt	Integer	open_at for array in unix epoch	[optional]

Return type

Query

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json, application/capnp
Accept: application/json, application/capnp

HTTP response details

Status code	Description	Response headers
200	query completed and results are returned in query object	* X-TILEDB-CLOUD-TASK-ID - Task ID for just completed request
204	query completed successfully with no return	-
502	Bad Gateway	-
0	error response	-

submitQueryJson

Object submitQueryJson(namespace, array, contentType, queryJson, xPayer)

send a query to run against a specified array/URI registered to a group/project, returns JSON results

Example

// Import classes:
import io.tiledb.cloud.rest_api.ApiClient;
import io.tiledb.cloud.rest_api.ApiException;
import io.tiledb.cloud.rest_api.Configuration;
import io.tiledb.cloud.rest_api.auth.*;
import io.tiledb.cloud.rest_api.models.*;
import io.tiledb.cloud.rest_api.api.QueryApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("/v1");
    
    // Configure HTTP basic authorization: BasicAuth
    HttpBasicAuth BasicAuth = (HttpBasicAuth) defaultClient.getAuthentication("BasicAuth");
    BasicAuth.setUsername("YOUR USERNAME");
    BasicAuth.setPassword("YOUR PASSWORD");

    // Configure API key authorization: ApiKeyAuth
    ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    ApiKeyAuth.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //ApiKeyAuth.setApiKeyPrefix("Token");

    QueryApi apiInstance = new QueryApi(defaultClient);
    String namespace = "namespace_example"; // String | namespace array is in (an organization name or user's username)
    String array = "array_example"; // String | name/uri of array that is url-encoded
    String contentType = "application/json"; // String | Content Type of input and return mime
    QueryJson queryJson = new QueryJson(); // QueryJson | query to run
    String xPayer = "xPayer_example"; // String | Name of organization or user who should be charged for this request
    try {
      Object result = apiInstance.submitQueryJson(namespace, array, contentType, queryJson, xPayer);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling QueryApi#submitQueryJson");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
namespace	String	namespace array is in (an organization name or user's username)
array	String	name/uri of array that is url-encoded
contentType	String	Content Type of input and return mime	[default to application/json]
queryJson	QueryJson	query to run
xPayer	String	Name of organization or user who should be charged for this request	[optional]

Return type

Object

Authorization

BasicAuth, ApiKeyAuth

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	query completed and results are returned in JSON format	* X-TILEDB-CLOUD-TASK-ID - Task ID for just completed request
502	Bad Gateway	-
0	error response	-

Files

QueryApi.md

Latest commit

History

QueryApi.md

File metadata and controls

QueryApi

finalizeQuery

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getEstResultSizes

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

getFile

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

submitQuery

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

submitQueryJson

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details