Deprecated features removal (#74)

* remove deprecated vector/vectorize parameters

* remove bulkWrite

* remove deleteAll

* removed namespace terminology

* removed db.collections()

* removed client.db(id, region)

* update api report

Author: toptobes

etc/astra-db-ts.api.md

@@ -23,12 +23,11 @@ import {
 } from '@/src/administration/types';
 import { AstraDbAdmin } from '@/src/administration/astra-db-admin';
 import { DbSpawnOptions, InternalRootClientOpts } from '@/src/client/types';
-import { Db, mkDb } from '@/src/db/db';
+import { Db } from '@/src/db/db';
 import { validateAdminOpts } from '@/src/administration/utils';
 import { DEFAULT_DEVOPS_API_ENDPOINTS, DEFAULT_KEYSPACE, HttpMethods } from '@/src/lib/api/constants';
 import { DevOpsAPIHttpClient } from '@/src/lib/api/clients/devops-api-http-client';
 import { TokenProvider, WithTimeout } from '@/src/lib';
-import { resolveKeyspace } from '@/src/lib/utils';
 
 /**
  * An administrative class for managing Astra databases, including creating, listing, and deleting databases.
@@ -155,7 +154,19 @@ export class AstraAdmin {
   public db(id: string, region: string, options?: DbSpawnOptions): Db;
 
   public db(endpointOrId: string, regionOrOptions?: string | DbSpawnOptions, maybeOptions?: DbSpawnOptions): Db {
-    return mkDb(this.#defaultOpts, endpointOrId, regionOrOptions, maybeOptions);
+    const dbOpts = (typeof regionOrOptions === 'string')
+      ? maybeOptions
+      : regionOrOptions;
+
+    if (typeof regionOrOptions === 'string' && (endpointOrId.startsWith('https://') || endpointOrId.startsWith('http://'))) {
+      throw new Error('Unexpected db() argument: database id can\'t start with "http(s)://". Did you mean to call `.db(endpoint, { keyspace })`?');
+    }
+
+    const endpoint = (typeof regionOrOptions === 'string')
+      ? 'https://' + endpointOrId + '-' + regionOrOptions + '.apps.astra.datastax.com'
+      : endpointOrId;
+
+    return new Db(this.#defaultOpts, endpoint, dbOpts);
   }
 
   /**
@@ -369,7 +380,7 @@ export class AstraAdmin {
       capacityUnits: 1,
       tier: 'serverless',
       dbType: 'vector',
-      keyspace: resolveKeyspace(config) || DEFAULT_KEYSPACE,
+      keyspace: config.keyspace || DEFAULT_KEYSPACE,
       ...config,
     };
 
@@ -385,7 +396,7 @@ export class AstraAdmin {
       options,
     });
 
-    const db = mkDb(this.#defaultOpts, resp.headers.location, definition.region, { ...options?.dbOptions, keyspace: definition.keyspace });
+    const db = this.db(resp.headers.location, definition.region, { ...options?.dbOptions, keyspace: definition.keyspace });
     return db.admin(this.#defaultOpts.adminOptions);
   }
 

src/administration/astra-admin.ts

@@ -13,13 +13,7 @@
 // limitations under the License.
 // noinspection ExceptionCaughtLocallyJS
 
-import {
-  AdminBlockingOptions,
-  AdminSpawnOptions,
-  CreateKeyspaceOptions,
-  CreateNamespaceOptions,
-  FullDatabaseInfo,
-} from '@/src/administration/types';
+import { AdminBlockingOptions, AdminSpawnOptions, CreateKeyspaceOptions, FullDatabaseInfo } from '@/src/administration/types';
 import { DbAdmin } from '@/src/administration/db-admin';
 import { WithTimeout } from '@/src/lib/types';
 import { InternalRootClientOpts } from '@/src/client/types';
@@ -198,18 +192,6 @@ export class AstraDbAdmin extends DbAdmin {
     return this.info(options).then(i => [i.info.keyspace!, ...i.info.additionalKeyspaces ?? []].filter(Boolean));
   }
 
-  /**
-   * Lists the keyspaces in the database.
-   *
-   * This is now a deprecated alias for the strictly equivalent {@link AstraDbAdmin.listKeyspaces}, and will be removed
-   * in an upcoming major version.
-   *
-   * @deprecated - Prefer {@link AstraDbAdmin.listKeyspaces} instead.
-   */
-  public override async listNamespaces(options?: WithTimeout): Promise<string[]> {
-    return this.listKeyspaces(options);
-  }
-
   /**
    * Creates a new, additional, keyspace for this database.
    *
@@ -257,20 +239,6 @@ export class AstraDbAdmin extends DbAdmin {
     });
   }
 
-  /**
-   * Creates a new, additional, keyspace for this database.
-   *
-   * This is now a deprecated alias for the strictly equivalent {@link AstraDbAdmin.createKeyspace}, and will be removed
-   * in an upcoming major version.
-   *
-   * https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5
-   *
-   * @deprecated - Prefer {@link AstraDbAdmin.createKeyspace} instead.
-   */
-  public override async createNamespace(keyspace: string, options?: CreateNamespaceOptions): Promise<void> {
-    return this.createKeyspace(keyspace, { ...options, updateDbKeyspace: options?.updateDbNamespace });
-  }
-
   /**
    * Drops a keyspace from this database.
    *
@@ -315,20 +283,6 @@ export class AstraDbAdmin extends DbAdmin {
     });
   }
 
-  /**
-   Drops a keyspace from this database.
-   *
-   * This is now a deprecated alias for the strictly equivalent {@link AstraDbAdmin.dropKeyspace}, and will be removed
-   * in an upcoming major version.
-   *
-   * https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5
-   *
-   * @deprecated - Prefer {@link AstraDbAdmin.dropKeyspace} instead.
-   */
-  public override async dropNamespace(keyspace: string, options?: AdminBlockingOptions): Promise<void> {
-    return this.dropKeyspace(keyspace, options);
-  }
-
   /**
    * Drops the database.
    *

src/administration/astra-db-admin.ts

@@ -13,12 +13,7 @@
 // limitations under the License.
 // noinspection ExceptionCaughtLocallyJS
 
-import {
-  AdminBlockingOptions,
-  AdminSpawnOptions,
-  LocalCreateKeyspaceOptions,
-  LocalCreateNamespaceOptions,
-} from '@/src/administration/types';
+import { AdminBlockingOptions, AdminSpawnOptions, LocalCreateKeyspaceOptions } from '@/src/administration/types';
 import { DbAdmin } from '@/src/administration/db-admin';
 import { WithTimeout } from '@/src/lib/types';
 import { validateAdminOpts } from '@/src/administration/utils';
@@ -139,19 +134,6 @@ export class DataAPIDbAdmin extends DbAdmin {
     return resp.status!.keyspaces;
   }
 
-  /**
-   * Lists the keyspaces in the database.
-   *
-   * This is now a deprecated alias for the strictly equivalent {@link DataAPIDbAdmin.listKeyspaces}, and will be removed
-   * in an upcoming major version.
-   *
-   * @deprecated - Prefer {@link DataAPIDbAdmin.listKeyspaces} instead.
-   */
-  public override async listNamespaces(options?: WithTimeout): Promise<string[]> {
-    const resp = await this.#httpClient.executeCommand({ findNamespaces: {} }, { maxTimeMS: options?.maxTimeMS, keyspace: null });
-    return resp.status!.namespaces;
-  }
-
   /**
    * Creates a new, additional, keyspace for this database.
    *
@@ -195,29 +177,6 @@ export class DataAPIDbAdmin extends DbAdmin {
     await this.#httpClient.executeCommand({ createKeyspace: { name: keyspace, options: { replication } } }, { maxTimeMS: options?.maxTimeMS, keyspace: null });
   }
 
-  /**
-   * Creates a new, additional, keyspace for this database.
-   *
-   * This is now a deprecated alias for the strictly equivalent {@link DataAPIDbAdmin.createKeyspace}, and will be removed
-   * in an upcoming major version.
-   *
-   * https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5
-   *
-   * @deprecated - Prefer {@link DataAPIDbAdmin.createKeyspace} instead.
-   */
-  public override async createNamespace(keyspace: string, options?: LocalCreateNamespaceOptions): Promise<void> {
-    if (options?.updateDbNamespace) {
-      this.#db.useKeyspace(keyspace);
-    }
-
-    const replication = options?.replication ?? {
-      class: 'SimpleStrategy',
-      replicationFactor: 1,
-    };
-
-    await this.#httpClient.executeCommand({ createNamespace: { name: keyspace, options: { replication } } }, { maxTimeMS: options?.maxTimeMS, keyspace: null });
-  }
-
   /**
    * Drops a keyspace from this database.
    *
@@ -243,20 +202,6 @@ export class DataAPIDbAdmin extends DbAdmin {
     await this.#httpClient.executeCommand({ dropKeyspace: { name: keyspace } }, { maxTimeMS: options?.maxTimeMS, keyspace: null });
   }
 
-  /**
-   Drops a keyspace from this database.
-   *
-   * This is now a deprecated alias for the strictly equivalent {@link DataAPIDbAdmin.dropKeyspace}, and will be removed
-   * in an upcoming major version.
-   *
-   * https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5
-   *
-   * @deprecated - Prefer {@link DataAPIDbAdmin.dropKeyspace} instead.
-   */
-  public override async dropNamespace(keyspace: string, options?: AdminBlockingOptions): Promise<void> {
-    await this.#httpClient.executeCommand({ dropNamespace: { name: keyspace } }, { maxTimeMS: options?.maxTimeMS, keyspace: null });
-  }
-
   private get _httpClient() {
     return this.#httpClient;
   }

src/administration/data-api-db-admin.ts

@@ -13,7 +13,7 @@
 // limitations under the License.
 // noinspection ExceptionCaughtLocallyJS
 
-import { AdminBlockingOptions, CreateKeyspaceOptions, CreateNamespaceOptions } from '@/src/administration/types';
+import { AdminBlockingOptions, CreateKeyspaceOptions } from '@/src/administration/types';
 import { FindEmbeddingProvidersResult } from '@/src/administration/types/db-admin/find-embedding-providers';
 import { WithTimeout } from '@/src/lib';
 import { Db } from '@/src/db';
@@ -82,17 +82,6 @@ export abstract class DbAdmin {
    * @returns A promise that resolves to list of all the keyspaces in the database.
    */
   abstract listKeyspaces(): Promise<string[]>;
-  /**
-   * Retrieves a list of all the keyspaces in the database.
-   *
-   * Creates a new, additional, keyspace for this database.
-   *
-   * This is now a deprecated alias for the strictly equivalent {@link DbAdmin.listKeyspaces}, and will be removed
-   * in an upcoming major version.
-   *
-   * @deprecated - Prefer {@link DbAdmin.listKeyspaces} instead.
-   */
-  abstract listNamespaces(): Promise<string[]>;
   /**
    * Creates a new, additional, keyspace for this database.
    *
@@ -124,17 +113,6 @@ export abstract class DbAdmin {
    * @returns A promise that resolves when the operation completes.
    */
   abstract createKeyspace(keyspace: string, options?: CreateKeyspaceOptions): Promise<void>;
-  /**
-   * Creates a new, additional, keyspace for this database.
-   *
-   * This is now a deprecated alias for the strictly equivalent {@link DbAdmin.createKeyspace}, and will be removed
-   * in an upcoming major version.
-   *
-   * https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5
-   *
-   * @deprecated - Prefer {@link DbAdmin.createKeyspace} instead.
-   */
-  abstract createNamespace(keyspace: string, options?: CreateNamespaceOptions): Promise<void>;
   /**
    * Drops a keyspace from this database.
    *
@@ -167,15 +145,4 @@ export abstract class DbAdmin {
    * @returns A promise that resolves when the operation completes.
    */
   abstract dropKeyspace(keyspace: string, options?: AdminBlockingOptions): Promise<void>;
-  /**
-   * Drops a keyspace from this database.
-   *
-   * This is now a deprecated alias for the strictly equivalent {@link DbAdmin.dropKeyspace}, and will be removed
-   * in an upcoming major version.
-   *
-   * https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5
-   *
-   * @deprecated - Prefer {@link DbAdmin.dropKeyspace} instead.
-   */
-  abstract dropNamespace(keyspace: string, options?: AdminBlockingOptions): Promise<void>;
 }

src/administration/db-admin.ts

@@ -43,17 +43,6 @@ export interface DatabaseConfig {
    * The default keyspace to use for the database.
    */
   keyspace?: string,
-  /**
-   * The default keyspace to use for the database.
-   *
-   * This is now a deprecated alias for the strictly equivalent {@link DatabaseConfig.keyspace}, and will be removed
-   * in an upcoming major version.
-   *
-   * https://docs.datastax.com/en/astra-db-serverless/api-reference/client-versions.html#version-1-5
-   *
-   * @deprecated - Prefer {@link DatabaseConfig.keyspace} instead.
-   */
-  namespace?: string,
 }
 
 /**

src/administration/types/admin/create-database.ts

@@ -43,15 +43,3 @@ import { AdminBlockingOptions } from '@/src/administration/types';
  * @public
  */
 export type CreateKeyspaceOptions = AdminBlockingOptions & { updateDbKeyspace?: boolean };
-
-/**
- * Represents the common options for creating a keyspace through the `astra-db-ts` client.
- *
- * This is now a deprecated alias for the strictly equivalent {@link CreateKeyspaceOptions}, and will be removed
- * in an upcoming major version.
- *
- * @deprecated - Prefer {@link CreateKeyspaceOptions} instead.
- *
- * @public
- */
-export type CreateNamespaceOptions = AdminBlockingOptions & { updateDbNamespace?: boolean };

src/administration/types/db-admin/create-keyspace.ts

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import { CreateKeyspaceOptions, CreateNamespaceOptions } from '@/src/administration';
+import { CreateKeyspaceOptions } from '@/src/administration';
 
 /**
  * Represents the options for creating a keyspace on a non-Astra database (i.e. blocking options + keyspace creation options).
@@ -44,18 +44,6 @@ import { CreateKeyspaceOptions, CreateNamespaceOptions } from '@/src/administrat
  */
 export type LocalCreateKeyspaceOptions = CreateKeyspaceOptions & { replication?: KeyspaceReplicationOptions };
 
-/**
- * Represents the options for creating a keyspace on a non-Astra database (i.e. blocking options + keyspace creation options).
- *
- * This is now a deprecated alias for the strictly equivalent {@link LocalCreateKeyspaceOptions}, and will be removed
- * in an upcoming major version.
- *
- * @deprecated - Prefer {@link LocalCreateKeyspaceOptions} instead.
- *
- * @public
- */
-export type LocalCreateNamespaceOptions = CreateNamespaceOptions & { replication?: KeyspaceReplicationOptions };
-
 /**
  * Represents the replication options for a keyspace.
  *

src/administration/types/db-admin/local-create-keyspace.ts

@@ -48,13 +48,11 @@ export type {
 
 export type {
   CreateKeyspaceOptions,
-  CreateNamespaceOptions,
 } from './db-admin/create-keyspace';
 
 export type {
   KeyspaceReplicationOptions,
   LocalCreateKeyspaceOptions,
-  LocalCreateNamespaceOptions,
 } from './db-admin/local-create-keyspace';
 
 export type {