@google-cloud/datastore-api 0.1.0

package/build/protos/google/datastore/admin/v1/index.proto

@@ -0,0 +1,122 @@
+// Copyright 2025 Google LLC
+//
+// 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.
+
+syntax = "proto3";
+
+package google.datastore.admin.v1;
+
+import "google/api/field_behavior.proto";
+
+option csharp_namespace = "Google.Cloud.Datastore.Admin.V1";
+option go_package = "cloud.google.com/go/datastore/admin/apiv1/adminpb;adminpb";
+option java_multiple_files = true;
+option java_outer_classname = "IndexProto";
+option java_package = "com.google.datastore.admin.v1";
+option php_namespace = "Google\\Cloud\\Datastore\\Admin\\V1";
+option ruby_package = "Google::Cloud::Datastore::Admin::V1";
+
+// Datastore composite index definition.
+message Index {
+  // For an ordered index, specifies whether each of the entity's ancestors
+  // will be included.
+  enum AncestorMode {
+    // The ancestor mode is unspecified.
+    ANCESTOR_MODE_UNSPECIFIED = 0;
+
+    // Do not include the entity's ancestors in the index.
+    NONE = 1;
+
+    // Include all the entity's ancestors in the index.
+    ALL_ANCESTORS = 2;
+  }
+
+  // The direction determines how a property is indexed.
+  enum Direction {
+    // The direction is unspecified.
+    DIRECTION_UNSPECIFIED = 0;
+
+    // The property's values are indexed so as to support sequencing in
+    // ascending order and also query by <, >, <=, >=, and =.
+    ASCENDING = 1;
+
+    // The property's values are indexed so as to support sequencing in
+    // descending order and also query by <, >, <=, >=, and =.
+    DESCENDING = 2;
+  }
+
+  // A property of an index.
+  message IndexedProperty {
+    // Required. The property name to index.
+    string name = 1 [(google.api.field_behavior) = REQUIRED];
+
+    // Required. The indexed property's direction.  Must not be
+    // DIRECTION_UNSPECIFIED.
+    Direction direction = 2 [(google.api.field_behavior) = REQUIRED];
+  }
+
+  // The possible set of states of an index.
+  enum State {
+    // The state is unspecified.
+    STATE_UNSPECIFIED = 0;
+
+    // The index is being created, and cannot be used by queries.
+    // There is an active long-running operation for the index.
+    // The index is updated when writing an entity.
+    // Some index data may exist.
+    CREATING = 1;
+
+    // The index is ready to be used.
+    // The index is updated when writing an entity.
+    // The index is fully populated from all stored entities it applies to.
+    READY = 2;
+
+    // The index is being deleted, and cannot be used by queries.
+    // There is an active long-running operation for the index.
+    // The index is not updated when writing an entity.
+    // Some index data may exist.
+    DELETING = 3;
+
+    // The index was being created or deleted, but something went wrong.
+    // The index cannot by used by queries.
+    // There is no active long-running operation for the index,
+    // and the most recently finished long-running operation failed.
+    // The index is not updated when writing an entity.
+    // Some index data may exist.
+    ERROR = 4;
+  }
+
+  // Output only. Project ID.
+  string project_id = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Output only. The resource ID of the index.
+  string index_id = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
+
+  // Required. The entity kind to which this index applies.
+  string kind = 4 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. The index's ancestor mode.  Must not be
+  // ANCESTOR_MODE_UNSPECIFIED.
+  AncestorMode ancestor = 5 [(google.api.field_behavior) = REQUIRED];
+
+  // Required. An ordered sequence of property names and their index attributes.
+  //
+  // Requires:
+  //
+  // * A maximum of 100 properties.
+  repeated IndexedProperty properties = 6
+      [(google.api.field_behavior) = REQUIRED];
+
+  // Output only. The state of the index.
+  State state = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
+}

package/build/protos/google/datastore/admin/v1/migration.proto

@@ -0,0 +1,124 @@
+// Copyright 2025 Google LLC
+//
+// 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.
+
+syntax = "proto3";
+
+package google.datastore.admin.v1;
+
+option csharp_namespace = "Google.Cloud.Datastore.Admin.V1";
+option go_package = "cloud.google.com/go/datastore/admin/apiv1/adminpb;adminpb";
+option java_multiple_files = true;
+option java_outer_classname = "MigrationProto";
+option java_package = "com.google.datastore.admin.v1";
+option php_namespace = "Google\\Cloud\\Datastore\\Admin\\V1";
+option ruby_package = "Google::Cloud::Datastore::Admin::V1";
+
+// An event signifying a change in state of a [migration from Cloud Datastore to
+// Cloud Firestore in Datastore
+// mode](https://cloud.google.com/datastore/docs/upgrade-to-firestore).
+message MigrationStateEvent {
+  // The new state of the migration.
+  MigrationState state = 1;
+}
+
+// An event signifying the start of a new step in a [migration from Cloud
+// Datastore to Cloud Firestore in Datastore
+// mode](https://cloud.google.com/datastore/docs/upgrade-to-firestore).
+message MigrationProgressEvent {
+  // Concurrency modes for transactions in Cloud Firestore.
+  enum ConcurrencyMode {
+    // Unspecified.
+    CONCURRENCY_MODE_UNSPECIFIED = 0;
+
+    // Pessimistic concurrency.
+    PESSIMISTIC = 1;
+
+    // Optimistic concurrency.
+    OPTIMISTIC = 2;
+
+    // Optimistic concurrency with entity groups.
+    OPTIMISTIC_WITH_ENTITY_GROUPS = 3;
+  }
+
+  // Details for the `PREPARE` step.
+  message PrepareStepDetails {
+    // The concurrency mode this database will use when it reaches the
+    // `REDIRECT_WRITES` step.
+    ConcurrencyMode concurrency_mode = 1;
+  }
+
+  // Details for the `REDIRECT_WRITES` step.
+  message RedirectWritesStepDetails {
+    // Ths concurrency mode for this database.
+    ConcurrencyMode concurrency_mode = 1;
+  }
+
+  // The step that is starting.
+  //
+  // An event with step set to `START` indicates that the migration
+  // has been reverted back to the initial pre-migration state.
+  MigrationStep step = 1;
+
+  // Details about this step.
+  oneof step_details {
+    // Details for the `PREPARE` step.
+    PrepareStepDetails prepare_step_details = 2;
+
+    // Details for the `REDIRECT_WRITES` step.
+    RedirectWritesStepDetails redirect_writes_step_details = 3;
+  }
+}
+
+// States for a migration.
+enum MigrationState {
+  // Unspecified.
+  MIGRATION_STATE_UNSPECIFIED = 0;
+
+  // The migration is running.
+  RUNNING = 1;
+
+  // The migration is paused.
+  PAUSED = 2;
+
+  // The migration is complete.
+  COMPLETE = 3;
+}
+
+// Steps in a migration.
+enum MigrationStep {
+  // Unspecified.
+  MIGRATION_STEP_UNSPECIFIED = 0;
+
+  // Pre-migration: the database is prepared for migration.
+  PREPARE = 6;
+
+  // Start of migration.
+  START = 1;
+
+  // Writes are applied synchronously to at least one replica.
+  APPLY_WRITES_SYNCHRONOUSLY = 7;
+
+  // Data is copied to Cloud Firestore and then verified to match the data in
+  // Cloud Datastore.
+  COPY_AND_VERIFY = 2;
+
+  // Eventually-consistent reads are redirected to Cloud Firestore.
+  REDIRECT_EVENTUALLY_CONSISTENT_READS = 3;
+
+  // Strongly-consistent reads are redirected to Cloud Firestore.
+  REDIRECT_STRONGLY_CONSISTENT_READS = 4;
+
+  // Writes are redirected to Cloud Firestore.
+  REDIRECT_WRITES = 5;
+}

package/build/protos/google/datastore/v1/aggregation_result.proto

@@ -0,0 +1,62 @@
+// Copyright 2026 Google LLC
+//
+// 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.
+
+syntax = "proto3";
+
+package google.datastore.v1;
+
+import "google/datastore/v1/entity.proto";
+import "google/datastore/v1/query.proto";
+import "google/protobuf/timestamp.proto";
+
+option csharp_namespace = "Google.Cloud.Datastore.V1";
+option go_package = "cloud.google.com/go/datastore/apiv1/datastorepb;datastorepb";
+option java_multiple_files = true;
+option java_outer_classname = "AggregationResultProto";
+option java_package = "com.google.datastore.v1";
+option php_namespace = "Google\\Cloud\\Datastore\\V1";
+option ruby_package = "Google::Cloud::Datastore::V1";
+
+// The result of a single bucket from a Datastore aggregation query.
+//
+// The keys of `aggregate_properties` are the same for all results in an
+// aggregation query, unlike entity queries which can have different fields
+// present for each result.
+message AggregationResult {
+  // The result of the aggregation functions, ex: `COUNT(*) AS total_entities`.
+  //
+  // The key is the
+  // [alias][google.datastore.v1.AggregationQuery.Aggregation.alias] assigned to
+  // the aggregation function on input and the size of this map equals the
+  // number of aggregation functions in the query.
+  map<string, Value> aggregate_properties = 2;
+}
+
+// A batch of aggregation results produced by an aggregation query.
+message AggregationResultBatch {
+  // The aggregation results for this batch.
+  repeated AggregationResult aggregation_results = 1;
+
+  // The state of the query after the current batch.
+  // Only COUNT(*) aggregations are supported in the initial launch. Therefore,
+  // expected result type is limited to `NO_MORE_RESULTS`.
+  QueryResultBatch.MoreResultsType more_results = 2;
+
+  // Read timestamp this batch was returned from.
+  //
+  // In a single transaction, subsequent query result batches for the same query
+  // can have a greater timestamp. Each batch's read timestamp
+  // is valid for all preceding batches.
+  google.protobuf.Timestamp read_time = 3;
+}