cruddl 6.0.0-alpha.1 → 6.0.0-alpha.2

package/dist/cjs/arangodb/aql-generator.d.ts

@@ -19,6 +19,11 @@ export interface QueryGenerationOptions {
      * See {@link ExecutionOptions.maxProjections} for details.
      */
     readonly maxProjections?: number;
+    /**
+     * An optional prefix prepended to all collection and view names in generated AQL queries.
+     * See {@link ArangoDBConfig.collectionNamePrefix} for details.
+     */
+    readonly collectionNamePrefix?: string;
 }
 export declare function getAQLQuery(node: QueryNode, options?: Partial<QueryGenerationOptions>): AQLCompoundQuery;
 export declare function generateTokenizationQuery(tokensFiltered: ReadonlyArray<FlexSearchTokenizable>): AQLFragment;

package/dist/cjs/arangodb/aql-generator.js

@@ -381,7 +381,9 @@ register(flex_search_js_2.FlexSearchQueryNode, (node, context) => {
     let itemContext = context
         .bindVariable(node.itemVariable)
         .withExtension(inFlexSearchFilterSymbol, true);
-    const viewName = (0, arango_search_helpers_js_1.getFlexSearchViewNameForRootEntity)(node.rootEntityType);
+    const viewName = (0, arango_search_helpers_js_1.getFlexSearchViewNameForRootEntity)(node.rootEntityType, {
+        prefix: context.options.collectionNamePrefix,
+    });
     context.addCollectionAccess(viewName, AccessType.EXPLICIT_READ);
     return aqlExt.subquery((0, aql_js_1.aql) `FOR ${itemContext.getVariable(node.itemVariable)}`, (0, aql_js_1.aql) `IN ${aql_js_1.aql.collection(viewName)}`, (0, aql_js_1.aql) `SEARCH ${processNode(node.flexFilterNode, itemContext)}`, node.isOptimisationsDisabled ? (0, aql_js_1.aql) `OPTIONS { conditionOptimization: 'none' }` : (0, aql_js_1.aql) ``, (0, aql_js_1.aql) `RETURN ${itemContext.getVariable(node.itemVariable)}`);
 });
@@ -1837,10 +1839,10 @@ function getRelationTraversalForStatements({ node, innermostItemVar, context, pr
     let sourceFrag;
     if (node.entitiesIdentifierKind === mutations_js_1.EntitiesIdentifierKind.ID) {
         if (node.sourceIsList) {
-            sourceFrag = getFullIDFromKeysFragment(plainSourceFrag, node.relationSegments[0].relationSide.sourceType);
+            sourceFrag = getFullIDFromKeysFragment(plainSourceFrag, node.relationSegments[0].relationSide.sourceType, context);
         }
         else {
-            sourceFrag = getFullIDFromKeyFragment(plainSourceFrag, node.relationSegments[0].relationSide.sourceType);
+            sourceFrag = getFullIDFromKeyFragment(plainSourceFrag, node.relationSegments[0].relationSide.sourceType, context);
         }
     }
     else {
@@ -1930,7 +1932,9 @@ function getRelationTraversalForStatements({ node, innermostItemVar, context, pr
             forFragments.push(traversalFrag);
             currentObjectFrag = nodeVar;
         }
-        context.addCollectionAccess((0, arango_basics_js_1.getCollectionNameForRootEntity)(segment.relationSide.targetType), AccessType.IMPLICIT_READ);
+        context.addCollectionAccess((0, arango_basics_js_1.getCollectionNameForRootEntity)(segment.relationSide.targetType, {
+            prefix: context.options.collectionNamePrefix,
+        }), AccessType.IMPLICIT_READ);
         segmentIndex++;
     }
     // each FOR automatically removes NULLs of the previous step (just how FOR works)
@@ -2125,14 +2129,14 @@ function getFullIDFromKeyNode(node, rootEntityType, context) {
     // special handling to avoid concat if possible - do not alter the behavior
     if (node instanceof literals_js_1.LiteralQueryNode && typeof node.value == 'string') {
         // just append the node to the literal key in JavaScript and bind it as a string
-        return (0, aql_js_1.aql) `${(0, arango_basics_js_1.getCollectionNameForRootEntity)(rootEntityType) + '/' + node.value}`;
+        return (0, aql_js_1.aql) `${(0, arango_basics_js_1.getCollectionNameForRootEntity)(rootEntityType, { prefix: context.options.collectionNamePrefix }) + '/' + node.value}`;
     }
     if (node instanceof queries_js_1.RootEntityIDQueryNode) {
         // access the _id field. processNode(node) would access the _key field instead.
         return (0, aql_js_1.aql) `${processNode(node.objectNode, context)}._id`;
     }
     // fall back to general case
-    return getFullIDFromKeyFragment(processNode(node, context), rootEntityType);
+    return getFullIDFromKeyFragment(processNode(node, context), rootEntityType, context);
 }
 function getFullIDsFromKeysNode(idsNode, rootEntityType, context) {
     if (idsNode instanceof lists_js_1.ListQueryNode) {
@@ -2143,18 +2147,20 @@ function getFullIDsFromKeysNode(idsNode, rootEntityType, context) {
     if (idsNode instanceof literals_js_1.LiteralQueryNode &&
         (0, utils_js_1.isReadonlyArray)(idsNode.value) &&
         idsNode.value.every((v) => typeof v === 'string')) {
-        const collName = (0, arango_basics_js_1.getCollectionNameForRootEntity)(rootEntityType);
+        const collName = (0, arango_basics_js_1.getCollectionNameForRootEntity)(rootEntityType, {
+            prefix: context.options.collectionNamePrefix,
+        });
         const ids = idsNode.value.map((val) => collName + '/' + val);
         return aql_js_1.aql.value(ids);
     }
-    return getFullIDFromKeysFragment(processNode(idsNode, context), rootEntityType);
+    return getFullIDFromKeysFragment(processNode(idsNode, context), rootEntityType, context);
 }
-function getFullIDFromKeyFragment(keyFragment, rootEntityType) {
-    return (0, aql_js_1.aql) `CONCAT(${(0, arango_basics_js_1.getCollectionNameForRootEntity)(rootEntityType) + '/'}, ${keyFragment})`;
+function getFullIDFromKeyFragment(keyFragment, rootEntityType, context) {
+    return (0, aql_js_1.aql) `CONCAT(${(0, arango_basics_js_1.getCollectionNameForRootEntity)(rootEntityType, { prefix: context.options.collectionNamePrefix }) + '/'}, ${keyFragment})`;
 }
-function getFullIDFromKeysFragment(keysFragment, rootEntityType) {
+function getFullIDFromKeysFragment(keysFragment, rootEntityType, context) {
     const idVar = aql_js_1.aql.variable('id');
-    return (0, aql_js_1.aql) `(FOR ${idVar} IN ${keysFragment} RETURN ${getFullIDFromKeyFragment(idVar, rootEntityType)})`;
+    return (0, aql_js_1.aql) `(FOR ${idVar} IN ${keysFragment} RETURN ${getFullIDFromKeyFragment(idVar, rootEntityType, context)})`;
 }
 function formatEdge(relation, edge, context) {
     const conditions = [];
@@ -2227,20 +2233,25 @@ function getAQLQuery(node, options = {}) {
         clock: options.clock ?? new execution_options_js_1.DefaultClock(),
         idGenerator: options.idGenerator ?? new execution_options_js_1.UUIDGenerator(),
         maxProjections: options.maxProjections,
+        collectionNamePrefix: options.collectionNamePrefix,
     }));
 }
 function getCollectionForBilling(accessType, context) {
-    const name = arango_basics_js_1.billingCollectionName;
+    const name = (context.options.collectionNamePrefix ?? '') + arango_basics_js_1.billingCollectionName;
     context.addCollectionAccess(name, accessType);
     return aql_js_1.aql.collection(name);
 }
 function getCollectionForType(type, accessType, context) {
-    const name = (0, arango_basics_js_1.getCollectionNameForRootEntity)(type);
+    const name = (0, arango_basics_js_1.getCollectionNameForRootEntity)(type, {
+        prefix: context.options.collectionNamePrefix,
+    });
     context.addCollectionAccess(name, accessType);
     return aql_js_1.aql.collection(name);
 }
 function getCollectionForRelation(relation, accessType, context) {
-    const name = (0, arango_basics_js_1.getCollectionNameForRelation)(relation);
+    const name = (0, arango_basics_js_1.getCollectionNameForRelation)(relation, {
+        prefix: context.options.collectionNamePrefix,
+    });
     context.addCollectionAccess(name, accessType);
     return aql_js_1.aql.collection(name);
 }
@@ -2250,7 +2261,9 @@ function getCollectionForRelation(relation, accessType, context) {
  */
 function getSimpleFollowEdgeFragment(node, context) {
     const dir = node.relationSide.isFromSide ? (0, aql_js_1.aql) `OUTBOUND` : (0, aql_js_1.aql) `INBOUND`;
-    context.addCollectionAccess((0, arango_basics_js_1.getCollectionNameForRootEntity)(node.relationSide.targetType), AccessType.IMPLICIT_READ);
+    context.addCollectionAccess((0, arango_basics_js_1.getCollectionNameForRootEntity)(node.relationSide.targetType, {
+        prefix: context.options.collectionNamePrefix,
+    }), AccessType.IMPLICIT_READ);
     return (0, aql_js_1.aql) `${dir} ${processNode(node.sourceEntityNode, context)} ${getCollectionForRelation(node.relationSide.relation, AccessType.EXPLICIT_READ, context)}`;
 }
 function generateTokenizationQuery(tokensFiltered) {

package/dist/cjs/arangodb/arango-basics.d.ts

@@ -1,5 +1,9 @@
 import type { Relation } from '../core/model/implementation/relation.js';
 import type { RootEntityType } from '../core/model/implementation/root-entity-type.js';
 export declare const billingCollectionName = "billingEntities";
-export declare function getCollectionNameForRootEntity(type: RootEntityType): string;
-export declare function getCollectionNameForRelation(relation: Relation): string;
+export declare function getCollectionNameForRootEntity(type: RootEntityType, { prefix }: {
+    prefix: string | undefined;
+}): string;
+export declare function getCollectionNameForRelation(relation: Relation, { prefix }: {
+    prefix: string | undefined;
+}): string;

package/dist/cjs/arangodb/arango-basics.js

@@ -5,9 +5,11 @@ exports.getCollectionNameForRootEntity = getCollectionNameForRootEntity;
 exports.getCollectionNameForRelation = getCollectionNameForRelation;
 const utils_js_1 = require("../core/utils/utils.js");
 exports.billingCollectionName = 'billingEntities';
-function getCollectionNameForRootEntity(type) {
-    return (0, utils_js_1.decapitalize)(type.pluralName);
+function getCollectionNameForRootEntity(type, { prefix }) {
+    return (prefix ?? '') + (0, utils_js_1.decapitalize)(type.pluralName);
 }
-function getCollectionNameForRelation(relation) {
-    return getCollectionNameForRootEntity(relation.fromType) + '_' + relation.fromField.name;
+function getCollectionNameForRelation(relation, { prefix }) {
+    return (getCollectionNameForRootEntity(relation.fromType, { prefix }) +
+        '_' +
+        relation.fromField.name);
 }

package/dist/cjs/arangodb/arangodb-adapter.js

@@ -34,6 +34,10 @@ class ArangoDBAdapter {
         this.config = config;
         this.schemaContext = schemaContext;
         this.logger = (0, config_js_1.getArangoDBLogger)(schemaContext);
+        if (config.collectionNamePrefix !== undefined &&
+            !/^[a-zA-Z0-9_]+$/.test(config.collectionNamePrefix)) {
+            throw new Error(`ArangoDBConfig.collectionNamePrefix must consist only of letters, digits, and underscores, but got: ${JSON.stringify(config.collectionNamePrefix)}`);
+        }
         this.db = (0, config_js_1.initDatabase)(config);
         this.analyzer = new analyzer_js_1.SchemaAnalyzer(config, schemaContext);
         this.migrationPerformer = new performer_js_1.MigrationPerformer(config);
@@ -223,6 +227,7 @@ class ArangoDBAdapter {
                 clock: options.clock,
                 idGenerator: options.idGenerator,
                 maxProjections: options.maxProjections,
+                collectionNamePrefix: this.config.collectionNamePrefix,
             });
             executableQueries = aqlQuery.getExecutableQueries();
         }

package/dist/cjs/arangodb/config.d.ts

@@ -58,6 +58,18 @@ export interface ArangoDBConfig {
      * Indices without names will never be ignored.
      */
     readonly nonManagedIndexNamesPattern?: RegExp;
+    /**
+     * An optional prefix that is prepended to all collection names (document collections, edge
+     * collections) and FlexSearch view names managed by this adapter.
+     *
+     * This allows multiple cruddl instances to share a single ArangoDB database without collection
+     * name collisions. Must consist only of letters, digits, and underscores
+     * (characters matching /^[a-zA-Z0-9_]+$/).
+     *
+     * Example: if set to "myapp_", a type "Order" will be stored in "myapp_orders" instead of
+     * "orders".
+     */
+    readonly collectionNamePrefix?: string;
 }
 export declare function initDatabase(config: ArangoDBConfig): Database;
 export declare function getArangoDBLogger(schemaContext: ProjectOptions | undefined): Logger;

package/dist/cjs/arangodb/schema-migration/analyzer.js

@@ -31,15 +31,18 @@ class SchemaAnalyzer {
         const existingCollectionNames = new Set(existingCollections.map((coll) => coll.name));
         const migrations = [];
         for (const rootEntity of model.rootEntityTypes) {
-            const collectionName = (0, arango_basics_js_1.getCollectionNameForRootEntity)(rootEntity);
+            const collectionName = (0, arango_basics_js_1.getCollectionNameForRootEntity)(rootEntity, {
+                prefix: this.config.collectionNamePrefix,
+            });
             if (existingCollectionNames.has(collectionName)) {
                 continue;
             }
             migrations.push(new migrations_js_1.CreateDocumentCollectionMigration(collectionName));
         }
-        if (!existingCollectionNames.has(arango_basics_js_1.billingCollectionName) &&
-            !migrations.some((value) => value.collectionName === arango_basics_js_1.billingCollectionName)) {
-            migrations.push(new migrations_js_1.CreateDocumentCollectionMigration(arango_basics_js_1.billingCollectionName));
+        const prefixedBillingCollectionName = (this.config.collectionNamePrefix ?? '') + arango_basics_js_1.billingCollectionName;
+        if (!existingCollectionNames.has(prefixedBillingCollectionName) &&
+            !migrations.some((value) => value.collectionName === prefixedBillingCollectionName)) {
+            migrations.push(new migrations_js_1.CreateDocumentCollectionMigration(prefixedBillingCollectionName));
         }
         return migrations;
     }
@@ -49,7 +52,9 @@ class SchemaAnalyzer {
         const existingCollectionNames = new Set(existingCollections.map((coll) => coll.name));
         const migrations = [];
         for (const relation of model.relations) {
-            const collectionName = (0, arango_basics_js_1.getCollectionNameForRelation)(relation);
+            const collectionName = (0, arango_basics_js_1.getCollectionNameForRelation)(relation, {
+                prefix: this.config.collectionNamePrefix,
+            });
             if (existingCollectionNames.has(collectionName)) {
                 continue;
             }
@@ -59,7 +64,9 @@ class SchemaAnalyzer {
     }
     async getIndexMigrations(model) {
         // update indices
-        const requiredIndices = (0, index_helpers_js_1.getRequiredIndicesFromModel)(model);
+        const requiredIndices = (0, index_helpers_js_1.getRequiredIndicesFromModel)(model, {
+            prefix: this.config.collectionNamePrefix,
+        });
         const existingIndicesPromises = model.rootEntityTypes.map((rootEntityType) => this.getPersistentCollectionIndices(rootEntityType));
         let existingIndices = [];
         await Promise.all(existingIndicesPromises).then((promiseResults) => promiseResults.forEach((indices) => indices.forEach((index) => existingIndices.push(index))));
@@ -92,7 +99,9 @@ class SchemaAnalyzer {
         ];
     }
     async getPersistentCollectionIndices(rootEntityType) {
-        const collectionName = (0, arango_basics_js_1.getCollectionNameForRootEntity)(rootEntityType);
+        const collectionName = (0, arango_basics_js_1.getCollectionNameForRootEntity)(rootEntityType, {
+            prefix: this.config.collectionNamePrefix,
+        });
         const coll = this.db.collection(collectionName);
         if (!(await coll.exists())) {
             return [];
@@ -129,11 +138,16 @@ class SchemaAnalyzer {
             }
         }
         // the views that match the model
-        const requiredViews = (0, arango_search_helpers_js_1.getRequiredViewsFromModel)(model);
+        const requiredViews = (0, arango_search_helpers_js_1.getRequiredViewsFromModel)(model, {
+            prefix: this.config.collectionNamePrefix,
+        });
         // the currently existing views
         const views = (await this.db.listViews())
             .map((value) => this.db.view(value.name))
-            .filter((view) => model.rootEntityTypes.some((rootEntityType) => view.name === (0, arango_search_helpers_js_1.getFlexSearchViewNameForRootEntity)(rootEntityType)));
+            .filter((view) => model.rootEntityTypes.some((rootEntityType) => view.name ===
+            (0, arango_search_helpers_js_1.getFlexSearchViewNameForRootEntity)(rootEntityType, {
+                prefix: this.config.collectionNamePrefix,
+            })));
         const configuration = this.config.arangoSearchConfiguration;
         const viewsToCreate = await (0, arango_search_helpers_js_1.calculateRequiredArangoSearchViewCreateOperations)(views, requiredViews, this.db, configuration);
         const viewsToDrop = (0, arango_search_helpers_js_1.calculateRequiredArangoSearchViewDropOperations)(views, requiredViews);

package/dist/cjs/arangodb/schema-migration/arango-search-helpers.d.ts

@@ -46,8 +46,12 @@ export interface ArangoSearchConfiguration {
      */
     readonly useRenameStrategyToRecreate?: boolean;
 }
-export declare function getRequiredViewsFromModel(model: Model): ReadonlyArray<ArangoSearchDefinition>;
-export declare function getFlexSearchViewNameForRootEntity(rootEntity: RootEntityType): string;
+export declare function getRequiredViewsFromModel(model: Model, { prefix }: {
+    prefix: string | undefined;
+}): ReadonlyArray<ArangoSearchDefinition>;
+export declare function getFlexSearchViewNameForRootEntity(rootEntity: RootEntityType, { prefix }: {
+    prefix: string | undefined;
+}): string;
 export declare function calculateRequiredArangoSearchViewCreateOperations(existingViews: ReadonlyArray<View>, requiredViews: ReadonlyArray<ArangoSearchDefinition>, db: Database, configuration?: ArangoSearchConfiguration): Promise<ReadonlyArray<SchemaMigration>>;
 export declare function calculateRequiredArangoSearchViewDropOperations(views: ReadonlyArray<View>, definitions: ReadonlyArray<ArangoSearchDefinition>): ReadonlyArray<SchemaMigration>;
 /**

package/dist/cjs/arangodb/schema-migration/arango-search-helpers.js

@@ -19,19 +19,21 @@ const string_map_js_1 = require("../../core/schema/scalars/string-map.js");
 const arango_basics_js_1 = require("../arango-basics.js");
 const migrations_js_1 = require("./migrations.js");
 exports.FLEX_SEARCH_VIEW_PREFIX = 'flex_view_';
-function getRequiredViewsFromModel(model) {
+function getRequiredViewsFromModel(model, { prefix }) {
     return model.rootEntityTypes
         .filter((value) => value.isFlexSearchIndexed)
-        .map((rootEntity) => getViewForRootEntity(rootEntity));
+        .map((rootEntity) => getViewForRootEntity(rootEntity, prefix));
 }
-function getFlexSearchViewNameForRootEntity(rootEntity) {
-    return exports.FLEX_SEARCH_VIEW_PREFIX + (0, arango_basics_js_1.getCollectionNameForRootEntity)(rootEntity);
+function getFlexSearchViewNameForRootEntity(rootEntity, { prefix }) {
+    return ((prefix ?? '') +
+        exports.FLEX_SEARCH_VIEW_PREFIX +
+        (0, arango_basics_js_1.getCollectionNameForRootEntity)(rootEntity, { prefix: undefined }));
 }
-function getViewForRootEntity(rootEntityType) {
+function getViewForRootEntity(rootEntityType, prefix) {
     return {
         rootEntityType,
-        viewName: getFlexSearchViewNameForRootEntity(rootEntityType),
-        collectionName: (0, arango_basics_js_1.getCollectionNameForRootEntity)(rootEntityType),
+        viewName: getFlexSearchViewNameForRootEntity(rootEntityType, { prefix }),
+        collectionName: (0, arango_basics_js_1.getCollectionNameForRootEntity)(rootEntityType, { prefix }),
         primarySort: rootEntityType.flexSearchPrimarySort.map((clause) => ({
             field: getPrimarySortFieldPath(clause.field),
             asc: clause.direction === order_js_1.OrderDirection.ASCENDING,

package/dist/cjs/arangodb/schema-migration/index-helpers.d.ts

@@ -13,7 +13,9 @@ export interface IndexDefinition {
 }
 export declare function describeIndex(index: IndexDefinition): string;
 export declare function getIndexDescriptor(index: IndexDefinition): string;
-export declare function getRequiredIndicesFromModel(model: Model): ReadonlyArray<IndexDefinition>;
+export declare function getRequiredIndicesFromModel(model: Model, { prefix }: {
+    prefix: string | undefined;
+}): ReadonlyArray<IndexDefinition>;
 export declare function calculateRequiredIndexOperations(existingIndices: ReadonlyArray<IndexDefinition>, requiredIndices: ReadonlyArray<IndexDefinition>, config: ArangoDBConfig): {
     indicesToDelete: ReadonlyArray<IndexDefinition>;
     indicesToCreate: ReadonlyArray<IndexDefinition>;

package/dist/cjs/arangodb/schema-migration/index-helpers.js

@@ -33,13 +33,13 @@ function indexDefinitionsEqual(a, b) {
             a.sparse === b.sparse &&
             a.type === b.type);
 }
-function getRequiredIndicesFromModel(model) {
-    return model.rootEntityTypes.flatMap((rootEntity) => getIndicesForRootEntity(rootEntity));
+function getRequiredIndicesFromModel(model, { prefix }) {
+    return model.rootEntityTypes.flatMap((rootEntity) => getIndicesForRootEntity(rootEntity, prefix));
 }
-function getIndicesForRootEntity(rootEntity) {
+function getIndicesForRootEntity(rootEntity, prefix) {
     return rootEntity.indices.map((index) => ({
         rootEntity,
-        collectionName: (0, arango_basics_js_1.getCollectionNameForRootEntity)(rootEntity),
+        collectionName: (0, arango_basics_js_1.getCollectionNameForRootEntity)(rootEntity, { prefix }),
         name: index.name,
         fields: index.fields.map(getArangoFieldPath),
         unique: index.unique,

package/dist/cjs/core/version.js

@@ -3,4 +3,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.CRUDDL_VERSION = void 0;
 // do not modify - this is parsed and changed by the build script
 // explicitly annotating with "string" so typescript won't infer a string literal type
-exports.CRUDDL_VERSION = '6.0.0-alpha.1';
+exports.CRUDDL_VERSION = '6.0.0-alpha.2';

package/dist/esm/arangodb/aql-generator.d.ts

@@ -19,6 +19,11 @@ export interface QueryGenerationOptions {
      * See {@link ExecutionOptions.maxProjections} for details.
      */
     readonly maxProjections?: number;
+    /**
+     * An optional prefix prepended to all collection and view names in generated AQL queries.
+     * See {@link ArangoDBConfig.collectionNamePrefix} for details.
+     */
+    readonly collectionNamePrefix?: string;
 }
 export declare function getAQLQuery(node: QueryNode, options?: Partial<QueryGenerationOptions>): AQLCompoundQuery;
 export declare function generateTokenizationQuery(tokensFiltered: ReadonlyArray<FlexSearchTokenizable>): AQLFragment;

package/dist/esm/arangodb/aql-generator.js

@@ -377,7 +377,9 @@ register(FlexSearchQueryNode, (node, context) => {
     let itemContext = context
         .bindVariable(node.itemVariable)
         .withExtension(inFlexSearchFilterSymbol, true);
-    const viewName = getFlexSearchViewNameForRootEntity(node.rootEntityType);
+    const viewName = getFlexSearchViewNameForRootEntity(node.rootEntityType, {
+        prefix: context.options.collectionNamePrefix,
+    });
     context.addCollectionAccess(viewName, AccessType.EXPLICIT_READ);
     return aqlExt.subquery(aql `FOR ${itemContext.getVariable(node.itemVariable)}`, aql `IN ${aql.collection(viewName)}`, aql `SEARCH ${processNode(node.flexFilterNode, itemContext)}`, node.isOptimisationsDisabled ? aql `OPTIONS { conditionOptimization: 'none' }` : aql ``, aql `RETURN ${itemContext.getVariable(node.itemVariable)}`);
 });
@@ -1833,10 +1835,10 @@ function getRelationTraversalForStatements({ node, innermostItemVar, context, pr
     let sourceFrag;
     if (node.entitiesIdentifierKind === EntitiesIdentifierKind.ID) {
         if (node.sourceIsList) {
-            sourceFrag = getFullIDFromKeysFragment(plainSourceFrag, node.relationSegments[0].relationSide.sourceType);
+            sourceFrag = getFullIDFromKeysFragment(plainSourceFrag, node.relationSegments[0].relationSide.sourceType, context);
         }
         else {
-            sourceFrag = getFullIDFromKeyFragment(plainSourceFrag, node.relationSegments[0].relationSide.sourceType);
+            sourceFrag = getFullIDFromKeyFragment(plainSourceFrag, node.relationSegments[0].relationSide.sourceType, context);
         }
     }
     else {
@@ -1926,7 +1928,9 @@ function getRelationTraversalForStatements({ node, innermostItemVar, context, pr
             forFragments.push(traversalFrag);
             currentObjectFrag = nodeVar;
         }
-        context.addCollectionAccess(getCollectionNameForRootEntity(segment.relationSide.targetType), AccessType.IMPLICIT_READ);
+        context.addCollectionAccess(getCollectionNameForRootEntity(segment.relationSide.targetType, {
+            prefix: context.options.collectionNamePrefix,
+        }), AccessType.IMPLICIT_READ);
         segmentIndex++;
     }
     // each FOR automatically removes NULLs of the previous step (just how FOR works)
@@ -2121,14 +2125,14 @@ function getFullIDFromKeyNode(node, rootEntityType, context) {
     // special handling to avoid concat if possible - do not alter the behavior
     if (node instanceof LiteralQueryNode && typeof node.value == 'string') {
         // just append the node to the literal key in JavaScript and bind it as a string
-        return aql `${getCollectionNameForRootEntity(rootEntityType) + '/' + node.value}`;
+        return aql `${getCollectionNameForRootEntity(rootEntityType, { prefix: context.options.collectionNamePrefix }) + '/' + node.value}`;
     }
     if (node instanceof RootEntityIDQueryNode) {
         // access the _id field. processNode(node) would access the _key field instead.
         return aql `${processNode(node.objectNode, context)}._id`;
     }
     // fall back to general case
-    return getFullIDFromKeyFragment(processNode(node, context), rootEntityType);
+    return getFullIDFromKeyFragment(processNode(node, context), rootEntityType, context);
 }
 function getFullIDsFromKeysNode(idsNode, rootEntityType, context) {
     if (idsNode instanceof ListQueryNode) {
@@ -2139,18 +2143,20 @@ function getFullIDsFromKeysNode(idsNode, rootEntityType, context) {
     if (idsNode instanceof LiteralQueryNode &&
         isReadonlyArray(idsNode.value) &&
         idsNode.value.every((v) => typeof v === 'string')) {
-        const collName = getCollectionNameForRootEntity(rootEntityType);
+        const collName = getCollectionNameForRootEntity(rootEntityType, {
+            prefix: context.options.collectionNamePrefix,
+        });
         const ids = idsNode.value.map((val) => collName + '/' + val);
         return aql.value(ids);
     }
-    return getFullIDFromKeysFragment(processNode(idsNode, context), rootEntityType);
+    return getFullIDFromKeysFragment(processNode(idsNode, context), rootEntityType, context);
 }
-function getFullIDFromKeyFragment(keyFragment, rootEntityType) {
-    return aql `CONCAT(${getCollectionNameForRootEntity(rootEntityType) + '/'}, ${keyFragment})`;
+function getFullIDFromKeyFragment(keyFragment, rootEntityType, context) {
+    return aql `CONCAT(${getCollectionNameForRootEntity(rootEntityType, { prefix: context.options.collectionNamePrefix }) + '/'}, ${keyFragment})`;
 }
-function getFullIDFromKeysFragment(keysFragment, rootEntityType) {
+function getFullIDFromKeysFragment(keysFragment, rootEntityType, context) {
     const idVar = aql.variable('id');
-    return aql `(FOR ${idVar} IN ${keysFragment} RETURN ${getFullIDFromKeyFragment(idVar, rootEntityType)})`;
+    return aql `(FOR ${idVar} IN ${keysFragment} RETURN ${getFullIDFromKeyFragment(idVar, rootEntityType, context)})`;
 }
 function formatEdge(relation, edge, context) {
     const conditions = [];
@@ -2223,20 +2229,25 @@ export function getAQLQuery(node, options = {}) {
         clock: options.clock ?? new DefaultClock(),
         idGenerator: options.idGenerator ?? new UUIDGenerator(),
         maxProjections: options.maxProjections,
+        collectionNamePrefix: options.collectionNamePrefix,
     }));
 }
 function getCollectionForBilling(accessType, context) {
-    const name = billingCollectionName;
+    const name = (context.options.collectionNamePrefix ?? '') + billingCollectionName;
     context.addCollectionAccess(name, accessType);
     return aql.collection(name);
 }
 function getCollectionForType(type, accessType, context) {
-    const name = getCollectionNameForRootEntity(type);
+    const name = getCollectionNameForRootEntity(type, {
+        prefix: context.options.collectionNamePrefix,
+    });
     context.addCollectionAccess(name, accessType);
     return aql.collection(name);
 }
 function getCollectionForRelation(relation, accessType, context) {
-    const name = getCollectionNameForRelation(relation);
+    const name = getCollectionNameForRelation(relation, {
+        prefix: context.options.collectionNamePrefix,
+    });
     context.addCollectionAccess(name, accessType);
     return aql.collection(name);
 }
@@ -2246,7 +2257,9 @@ function getCollectionForRelation(relation, accessType, context) {
  */
 function getSimpleFollowEdgeFragment(node, context) {
     const dir = node.relationSide.isFromSide ? aql `OUTBOUND` : aql `INBOUND`;
-    context.addCollectionAccess(getCollectionNameForRootEntity(node.relationSide.targetType), AccessType.IMPLICIT_READ);
+    context.addCollectionAccess(getCollectionNameForRootEntity(node.relationSide.targetType, {
+        prefix: context.options.collectionNamePrefix,
+    }), AccessType.IMPLICIT_READ);
     return aql `${dir} ${processNode(node.sourceEntityNode, context)} ${getCollectionForRelation(node.relationSide.relation, AccessType.EXPLICIT_READ, context)}`;
 }
 export function generateTokenizationQuery(tokensFiltered) {

package/dist/esm/arangodb/arango-basics.d.ts

@@ -1,5 +1,9 @@
 import type { Relation } from '../core/model/implementation/relation.js';
 import type { RootEntityType } from '../core/model/implementation/root-entity-type.js';
 export declare const billingCollectionName = "billingEntities";
-export declare function getCollectionNameForRootEntity(type: RootEntityType): string;
-export declare function getCollectionNameForRelation(relation: Relation): string;
+export declare function getCollectionNameForRootEntity(type: RootEntityType, { prefix }: {
+    prefix: string | undefined;
+}): string;
+export declare function getCollectionNameForRelation(relation: Relation, { prefix }: {
+    prefix: string | undefined;
+}): string;

package/dist/esm/arangodb/arango-basics.js

@@ -1,8 +1,10 @@
 import { decapitalize } from '../core/utils/utils.js';
 export const billingCollectionName = 'billingEntities';
-export function getCollectionNameForRootEntity(type) {
-    return decapitalize(type.pluralName);
+export function getCollectionNameForRootEntity(type, { prefix }) {
+    return (prefix ?? '') + decapitalize(type.pluralName);
 }
-export function getCollectionNameForRelation(relation) {
-    return getCollectionNameForRootEntity(relation.fromType) + '_' + relation.fromField.name;
+export function getCollectionNameForRelation(relation, { prefix }) {
+    return (getCollectionNameForRootEntity(relation.fromType, { prefix }) +
+        '_' +
+        relation.fromField.name);
 }

package/dist/esm/arangodb/arangodb-adapter.js

@@ -32,6 +32,10 @@ export class ArangoDBAdapter {
         this.config = config;
         this.schemaContext = schemaContext;
         this.logger = getArangoDBLogger(schemaContext);
+        if (config.collectionNamePrefix !== undefined &&
+            !/^[a-zA-Z0-9_]+$/.test(config.collectionNamePrefix)) {
+            throw new Error(`ArangoDBConfig.collectionNamePrefix must consist only of letters, digits, and underscores, but got: ${JSON.stringify(config.collectionNamePrefix)}`);
+        }
         this.db = initDatabase(config);
         this.analyzer = new SchemaAnalyzer(config, schemaContext);
         this.migrationPerformer = new MigrationPerformer(config);
@@ -221,6 +225,7 @@ export class ArangoDBAdapter {
                 clock: options.clock,
                 idGenerator: options.idGenerator,
                 maxProjections: options.maxProjections,
+                collectionNamePrefix: this.config.collectionNamePrefix,
             });
             executableQueries = aqlQuery.getExecutableQueries();
         }

package/dist/esm/arangodb/config.d.ts

@@ -58,6 +58,18 @@ export interface ArangoDBConfig {
      * Indices without names will never be ignored.
      */
     readonly nonManagedIndexNamesPattern?: RegExp;
+    /**
+     * An optional prefix that is prepended to all collection names (document collections, edge
+     * collections) and FlexSearch view names managed by this adapter.
+     *
+     * This allows multiple cruddl instances to share a single ArangoDB database without collection
+     * name collisions. Must consist only of letters, digits, and underscores
+     * (characters matching /^[a-zA-Z0-9_]+$/).
+     *
+     * Example: if set to "myapp_", a type "Order" will be stored in "myapp_orders" instead of
+     * "orders".
+     */
+    readonly collectionNamePrefix?: string;
 }
 export declare function initDatabase(config: ArangoDBConfig): Database;
 export declare function getArangoDBLogger(schemaContext: ProjectOptions | undefined): Logger;

package/dist/esm/arangodb/schema-migration/analyzer.js

@@ -28,15 +28,18 @@ export class SchemaAnalyzer {
         const existingCollectionNames = new Set(existingCollections.map((coll) => coll.name));
         const migrations = [];
         for (const rootEntity of model.rootEntityTypes) {
-            const collectionName = getCollectionNameForRootEntity(rootEntity);
+            const collectionName = getCollectionNameForRootEntity(rootEntity, {
+                prefix: this.config.collectionNamePrefix,
+            });
             if (existingCollectionNames.has(collectionName)) {
                 continue;
             }
             migrations.push(new CreateDocumentCollectionMigration(collectionName));
         }
-        if (!existingCollectionNames.has(billingCollectionName) &&
-            !migrations.some((value) => value.collectionName === billingCollectionName)) {
-            migrations.push(new CreateDocumentCollectionMigration(billingCollectionName));
+        const prefixedBillingCollectionName = (this.config.collectionNamePrefix ?? '') + billingCollectionName;
+        if (!existingCollectionNames.has(prefixedBillingCollectionName) &&
+            !migrations.some((value) => value.collectionName === prefixedBillingCollectionName)) {
+            migrations.push(new CreateDocumentCollectionMigration(prefixedBillingCollectionName));
         }
         return migrations;
     }
@@ -46,7 +49,9 @@ export class SchemaAnalyzer {
         const existingCollectionNames = new Set(existingCollections.map((coll) => coll.name));
         const migrations = [];
         for (const relation of model.relations) {
-            const collectionName = getCollectionNameForRelation(relation);
+            const collectionName = getCollectionNameForRelation(relation, {
+                prefix: this.config.collectionNamePrefix,
+            });
             if (existingCollectionNames.has(collectionName)) {
                 continue;
             }
@@ -56,7 +61,9 @@ export class SchemaAnalyzer {
     }
     async getIndexMigrations(model) {
         // update indices
-        const requiredIndices = getRequiredIndicesFromModel(model);
+        const requiredIndices = getRequiredIndicesFromModel(model, {
+            prefix: this.config.collectionNamePrefix,
+        });
         const existingIndicesPromises = model.rootEntityTypes.map((rootEntityType) => this.getPersistentCollectionIndices(rootEntityType));
         let existingIndices = [];
         await Promise.all(existingIndicesPromises).then((promiseResults) => promiseResults.forEach((indices) => indices.forEach((index) => existingIndices.push(index))));
@@ -89,7 +96,9 @@ export class SchemaAnalyzer {
         ];
     }
     async getPersistentCollectionIndices(rootEntityType) {
-        const collectionName = getCollectionNameForRootEntity(rootEntityType);
+        const collectionName = getCollectionNameForRootEntity(rootEntityType, {
+            prefix: this.config.collectionNamePrefix,
+        });
         const coll = this.db.collection(collectionName);
         if (!(await coll.exists())) {
             return [];
@@ -126,11 +135,16 @@ export class SchemaAnalyzer {
             }
         }
         // the views that match the model
-        const requiredViews = getRequiredViewsFromModel(model);
+        const requiredViews = getRequiredViewsFromModel(model, {
+            prefix: this.config.collectionNamePrefix,
+        });
         // the currently existing views
         const views = (await this.db.listViews())
             .map((value) => this.db.view(value.name))
-            .filter((view) => model.rootEntityTypes.some((rootEntityType) => view.name === getFlexSearchViewNameForRootEntity(rootEntityType)));
+            .filter((view) => model.rootEntityTypes.some((rootEntityType) => view.name ===
+            getFlexSearchViewNameForRootEntity(rootEntityType, {
+                prefix: this.config.collectionNamePrefix,
+            })));
         const configuration = this.config.arangoSearchConfiguration;
         const viewsToCreate = await calculateRequiredArangoSearchViewCreateOperations(views, requiredViews, this.db, configuration);
         const viewsToDrop = calculateRequiredArangoSearchViewDropOperations(views, requiredViews);

package/dist/esm/arangodb/schema-migration/arango-search-helpers.d.ts

@@ -46,8 +46,12 @@ export interface ArangoSearchConfiguration {
      */
     readonly useRenameStrategyToRecreate?: boolean;
 }
-export declare function getRequiredViewsFromModel(model: Model): ReadonlyArray<ArangoSearchDefinition>;
-export declare function getFlexSearchViewNameForRootEntity(rootEntity: RootEntityType): string;
+export declare function getRequiredViewsFromModel(model: Model, { prefix }: {
+    prefix: string | undefined;
+}): ReadonlyArray<ArangoSearchDefinition>;
+export declare function getFlexSearchViewNameForRootEntity(rootEntity: RootEntityType, { prefix }: {
+    prefix: string | undefined;
+}): string;
 export declare function calculateRequiredArangoSearchViewCreateOperations(existingViews: ReadonlyArray<View>, requiredViews: ReadonlyArray<ArangoSearchDefinition>, db: Database, configuration?: ArangoSearchConfiguration): Promise<ReadonlyArray<SchemaMigration>>;
 export declare function calculateRequiredArangoSearchViewDropOperations(views: ReadonlyArray<View>, definitions: ReadonlyArray<ArangoSearchDefinition>): ReadonlyArray<SchemaMigration>;
 /**

package/dist/esm/arangodb/schema-migration/arango-search-helpers.js

@@ -8,19 +8,21 @@ import { GraphQLI18nString } from '../../core/schema/scalars/string-map.js';
 import { getCollectionNameForRootEntity } from '../arango-basics.js';
 import { CreateArangoSearchViewMigration, DropArangoSearchViewMigration, RecreateArangoSearchViewMigration, UpdateArangoSearchViewMigration, } from './migrations.js';
 export const FLEX_SEARCH_VIEW_PREFIX = 'flex_view_';
-export function getRequiredViewsFromModel(model) {
+export function getRequiredViewsFromModel(model, { prefix }) {
     return model.rootEntityTypes
         .filter((value) => value.isFlexSearchIndexed)
-        .map((rootEntity) => getViewForRootEntity(rootEntity));
+        .map((rootEntity) => getViewForRootEntity(rootEntity, prefix));
 }
-export function getFlexSearchViewNameForRootEntity(rootEntity) {
-    return FLEX_SEARCH_VIEW_PREFIX + getCollectionNameForRootEntity(rootEntity);
+export function getFlexSearchViewNameForRootEntity(rootEntity, { prefix }) {
+    return ((prefix ?? '') +
+        FLEX_SEARCH_VIEW_PREFIX +
+        getCollectionNameForRootEntity(rootEntity, { prefix: undefined }));
 }
-function getViewForRootEntity(rootEntityType) {
+function getViewForRootEntity(rootEntityType, prefix) {
     return {
         rootEntityType,
-        viewName: getFlexSearchViewNameForRootEntity(rootEntityType),
-        collectionName: getCollectionNameForRootEntity(rootEntityType),
+        viewName: getFlexSearchViewNameForRootEntity(rootEntityType, { prefix }),
+        collectionName: getCollectionNameForRootEntity(rootEntityType, { prefix }),
         primarySort: rootEntityType.flexSearchPrimarySort.map((clause) => ({
             field: getPrimarySortFieldPath(clause.field),
             asc: clause.direction === OrderDirection.ASCENDING,

package/dist/esm/arangodb/schema-migration/index-helpers.d.ts

@@ -13,7 +13,9 @@ export interface IndexDefinition {
 }
 export declare function describeIndex(index: IndexDefinition): string;
 export declare function getIndexDescriptor(index: IndexDefinition): string;
-export declare function getRequiredIndicesFromModel(model: Model): ReadonlyArray<IndexDefinition>;
+export declare function getRequiredIndicesFromModel(model: Model, { prefix }: {
+    prefix: string | undefined;
+}): ReadonlyArray<IndexDefinition>;
 export declare function calculateRequiredIndexOperations(existingIndices: ReadonlyArray<IndexDefinition>, requiredIndices: ReadonlyArray<IndexDefinition>, config: ArangoDBConfig): {
     indicesToDelete: ReadonlyArray<IndexDefinition>;
     indicesToCreate: ReadonlyArray<IndexDefinition>;

package/dist/esm/arangodb/schema-migration/index-helpers.js

@@ -27,13 +27,13 @@ function indexDefinitionsEqual(a, b) {
             a.sparse === b.sparse &&
             a.type === b.type);
 }
-export function getRequiredIndicesFromModel(model) {
-    return model.rootEntityTypes.flatMap((rootEntity) => getIndicesForRootEntity(rootEntity));
+export function getRequiredIndicesFromModel(model, { prefix }) {
+    return model.rootEntityTypes.flatMap((rootEntity) => getIndicesForRootEntity(rootEntity, prefix));
 }
-function getIndicesForRootEntity(rootEntity) {
+function getIndicesForRootEntity(rootEntity, prefix) {
     return rootEntity.indices.map((index) => ({
         rootEntity,
-        collectionName: getCollectionNameForRootEntity(rootEntity),
+        collectionName: getCollectionNameForRootEntity(rootEntity, { prefix }),
         name: index.name,
         fields: index.fields.map(getArangoFieldPath),
         unique: index.unique,

package/dist/esm/core/version.js

@@ -1,3 +1,3 @@
 // do not modify - this is parsed and changed by the build script
 // explicitly annotating with "string" so typescript won't infer a string literal type
-export const CRUDDL_VERSION = '6.0.0-alpha.1';
+export const CRUDDL_VERSION = '6.0.0-alpha.2';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cruddl",
-  "version": "6.0.0-alpha.1",
+  "version": "6.0.0-alpha.2",
   "description": "",
   "license": "MIT",
   "type": "module",