io.inversion.cosmosdb.CosmosDb Maven / Gradle / Ivy
/*
* Copyright (c) 2015-2020 Rocket Partners, LLC
* https://github.com/inversion-api
*
* 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
*
* http://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 io.inversion.cosmosdb;
import com.microsoft.azure.documentdb.*;
import io.inversion.Index;
import io.inversion.*;
import io.inversion.json.JSMap;
import io.inversion.rql.Term;
import io.inversion.utils.Utils;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class CosmosDb extends Db {
public static final String INDEX_TYPE_PARTITION_KEY = "PartitionKey";
protected String uri = null;
protected String db = "";
protected String key = null;
transient protected DocumentClient documentClient = null;
boolean allowCrossPartitionQueries = false;
transient ConnectionPolicy connectionPolicy = null;
public CosmosDb() {
this.withType("cosmosdb");
}
public CosmosDb(String name) {
this();
withName(name);
}
public static DocumentClient buildDocumentClient(String uri, String key, ConnectionPolicy connectionPolicy) {
if (Utils.empty(uri) || Utils.empty(key)) {
String error = "";
error += "Unable to connect to Cosmos DB because conf values for 'uri' or 'key' can not be found. ";
error += "If this is a development environment, you should probably add these key/value pairs to a '.env' properties file in your working directory. ";
error += "If this is a production deployment, you should probably set these as environment variables on your container.";
error += "You could call CosmosDocumentDb.withUri() and CosmosDocumentDb.withKey() directly in your code but compiling these ";
error += "values into your code is strongly discouraged as a poor security practice.";
throw ApiException.new500InternalServerError(error);
}
connectionPolicy = ConnectionPolicy.GetDefault();
DocumentClient client = new DocumentClient(uri, key, connectionPolicy, ConsistencyLevel.Session);
return client;
}
/**
* Finds the resource keys on the other side of the relationship
*
* @param collection the collection to query
* @param columnMappedTerms the query terms
* @return Map key=sourceResourceKey, value=relatedResourceKey
* @throws ApiException if selection fails for any reason
*/
@Override
public Results doSelect(Collection collection, List columnMappedTerms) throws ApiException {
Index partitionIdx = collection.getIndexByType(INDEX_TYPE_PARTITION_KEY);
if (partitionIdx != null) {
Map values = new HashMap<>();
for (Property prop : partitionIdx.getProperties()) {
String colName = prop.getColumnName();
for (Term term : columnMappedTerms) {
if (term.hasChildLeafToken("eq") && colName.equals(term.getToken(0))) {
values.put(colName, term.getToken(1));
break;
}
}
}
for (Term term : columnMappedTerms) {
if (term.hasToken("_key")) {
String indexName = term.getToken(0);
Index idx = collection.getIndex(indexName);
Map key = collection.decodeKeyToColumnNames(idx, term.getToken(1));
// Rows.Row key = collection.decodeResourceKey(term.getToken(0));
for (Property prop : partitionIdx.getProperties()) {
String colName = prop.getColumnName();
if (key.containsKey(colName))
values.put(colName, key.get(colName));
}
}
}
//if the query supplied the parts necessary to construct the
if (values.size() == partitionIdx.size()) {
//-- remove any explicit partitionKey query params supplied by the users
columnMappedTerms.removeIf(term -> term.hasToken("eq") && partitionIdx.getName().equals(term.getToken(0)));
String partitionKey = io.inversion.Collection.encodeKey(values, partitionIdx, false);
columnMappedTerms.add(Term.term(null, "eq", partitionIdx.getName(), partitionKey));
}
}
CosmosSqlQuery query = new CosmosSqlQuery(this, collection, columnMappedTerms);
return query.doSelect();
}
@Override
public List doUpsert(Collection table, List> rows) throws ApiException {
List keys = new ArrayList<>();
for (Map row : rows) {
keys.add(upsertRow(table, row));
}
return keys;
}
void normalizePartitionKey(Collection collection, Map row) {
//-- makes sure the partition key is set correctly on the document if there is one.
Index partitionIdx = collection.getIndexByType(INDEX_TYPE_PARTITION_KEY);
if (partitionIdx != null) {
String partitionKey = io.inversion.Collection.encodeKey(row, partitionIdx, false);
if (partitionKey == null)
throw ApiException.new400BadRequest("Unable to determine the CosmosDb partition key from the supplied fields");
row.put(partitionIdx.getName(), partitionKey);
}
}
public String upsertRow(Collection collection, Map row) throws ApiException {
try {
normalizePartitionKey(collection, row);
JSMap doc = new JSMap(row);
String id = doc.getString("id");
if (id == null) {
id = collection.encodeKeyFromColumnNames(row);
if (id == null)
throw ApiException.new400BadRequest("Your record does not contain the required key fields.");
doc.putFirst("id", id);
}
//-- the only way to achieve a PATCH is to query for the document first.
Results existing = doSelect(collection, Utils.asList(Term.term(null, "_key", collection.getResourceIndex().getName(), id)));
if (existing.size() == 1) {
Map existingRow = existing.getRow(0);
for (String key : existingRow.keySet()) {
if (!doc.containsKey(key))
doc.put(key, existingRow.get(key));
}
}
//-- https://docs.microsoft.com/en-us/rest/api/cosmos-db/cosmosdb-resource-uri-syntax-for-rest
String cosmosCollectionUri = "/dbs/" + db + "/colls/" + collection.getTableName();
String json = doc.toString();
Document document = new Document(json);
String debug = "CosmosDb: Insert " + json;
Chain.debug(debug);
ResourceResponse response = getDocumentClient().upsertDocument(cosmosCollectionUri, document, new RequestOptions(), true);
int statusCode = response.getStatusCode();
if (statusCode > 299) {
throw ApiException.new400BadRequest("Unexpected http status code returned from database: '{}'", statusCode);
}
String returnedId = response.getResource().getId();
if (!Utils.equal(id, returnedId))
throw ApiException.new500InternalServerError("The supplied 'id' field does not match the returned 'id' field: '{}' vs. '{}'", id, returnedId);
return id;
} catch (Exception ex) {
throw ApiException.new500InternalServerError(ex);
}
}
@Override
public void doDelete(Collection table, List> indexValues) throws ApiException {
for (Map row : indexValues) {
deleteRow(table, row);
}
}
/**
* Deletes a single specific resource.
*
* Rest url format for Cosmos deletions - https://{databaseaccount}.documents.azure.com/dbs/{db}/colls/{coll}/docs/{doc}
*
* @param collection the collection to delete
* @param indexValues identifiers for the documents to delete
* @see CosmosDb Resource URI Syntax
*/
protected void deleteRow(Collection collection, Map indexValues) throws ApiException {
normalizePartitionKey(collection, indexValues);
Object id = collection.encodeKeyFromColumnNames(indexValues);
Object partitionKeyValue = indexValues.get(collection.getIndex(CosmosDb.INDEX_TYPE_PARTITION_KEY).getProperty(0).getColumnName());
String documentUri = "/dbs/" + db + "/colls/" + collection.getTableName() + "/docs/" + id;
RequestOptions options = new RequestOptions();
options.setPartitionKey(new PartitionKey(partitionKeyValue));
ResourceResponse response;
try {
Chain.debug("CosmosDb: Delete documentUri=" + documentUri + "partitionKeyValue=" + partitionKeyValue);
response = getDocumentClient().deleteDocument(documentUri, options);
int statusCode = response.getStatusCode();
if (statusCode >= 400) {
throw ApiException.new500InternalServerError("Unexpected http status code returned from database: {}", statusCode);
}
} catch (DocumentClientException ex) {
ex.printStackTrace();
int statusCode = ex.getStatusCode();
if (statusCode == 404) {
//ignore attempts to delete things that don't exist
} else {
throw ApiException.new500InternalServerError(ex);
}
}
}
protected String getCollectionUri(Collection table) {
String documentUri = "/dbs/" + db + "/colls/" + table.getTableName();
return documentUri;
}
public String getUri() {
return uri;
}
public CosmosDb withUri(String uri) {
this.uri = uri;
return this;
}
public String getDb() {
return db;
}
public CosmosDb withDb(String db) {
this.db = db;
return this;
}
public String getKey() {
return key;
}
public CosmosDb withKey(String key) {
this.key = key;
return this;
}
public boolean isAllowCrossPartitionQueries() {
return allowCrossPartitionQueries;
}
public CosmosDb withAllowCrossPartitionQueries(boolean allowCrossPartitionQueries) {
this.allowCrossPartitionQueries = allowCrossPartitionQueries;
return this;
}
public synchronized CosmosDb withDocumentClient(DocumentClient documentClient) {
this.documentClient = documentClient;
return this;
}
public synchronized DocumentClient getDocumentClient() {
if (this.documentClient == null) {
synchronized (this) {
if (this.documentClient == null) {
if(this.connectionPolicy == null){
connectionPolicy = new ConnectionPolicy();
connectionPolicy.setConnectionMode(ConnectionMode.DirectHttps);
connectionPolicy.setMaxPoolSize(10);
}
this.documentClient = buildDocumentClient(uri, key, connectionPolicy);
}
}
}
return documentClient;
}
}