@neo4j/cypher-builder
Version:
A programmatic API for building Cypher queries for Neo4j
75 lines (74 loc) • 3.47 kB
TypeScript
import { CypherFunction } from "../../expressions/functions/CypherFunctions";
import { CypherProcedure, VoidCypherProcedure } from "../../procedures/CypherProcedure";
import type { Expr } from "../../types";
export * as cdc from "./cdc";
/**
* @hideGroups
*/
export * as index from "./index/dbIndex";
export * as schema from "./schema";
/**
* @see [Neo4j Documentation](https://neo4j.com/docs/cypher-manual/current/functions/database/#functions-database-nameFromElementId)
* @group Functions
*/
export declare function nameFromElementId(dbName: Expr | string): CypherFunction;
/**
* @see [Neo4j Documentation](https://neo4j.com/docs/operations-manual/current/reference/procedures/#procedure_db_awaitindex)
* @group Functions
*/
export declare function awaitIndex(indexName: Expr | string, timeOutSeconds: Expr | number): VoidCypherProcedure;
/**
* @see [Neo4j Documentation](https://neo4j.com/docs/operations-manual/current/reference/procedures/#procedure_db_awaitindexes)
* @group Functions
*/
export declare function awaitIndexes(timeOutSeconds: Expr | number): VoidCypherProcedure;
/**
* @see [Neo4j Documentation](https://neo4j.com/docs/operations-manual/current/reference/procedures/#procedure_db_createlabel)
* @group Procedures
*/
export declare function createLabel(newLabel: Expr | string): VoidCypherProcedure;
/**
* @see [Neo4j Documentation](https://neo4j.com/docs/operations-manual/current/reference/procedures/#procedure_db_createproperty)
* @group Procedures
*/
export declare function createProperty(newProperty: Expr | string): VoidCypherProcedure;
/**
* @see [Neo4j Documentation](https://neo4j.com/docs/operations-manual/current/reference/procedures/#procedure_db_createrelationshiptype)
* @group Procedures
*/
export declare function createRelationshipType(newRelationshipType: Expr | string): VoidCypherProcedure;
/**
* @see [Neo4j Documentation](https://neo4j.com/docs/operations-manual/current/reference/procedures/#procedure_db_info)
* @group Procedures
*/
export declare function info(): CypherProcedure<"id" | "creationDate">;
/** Returns all labels in the database
* @see [Neo4j Documentation](https://neo4j.com/docs/operations-manual/5/reference/procedures/#procedure_db_labels)
* @group Procedures
*/
export declare function labels(): CypherProcedure<"label">;
/**
* @see [Neo4j Documentation](https://neo4j.com/docs/operations-manual/current/reference/procedures/#procedure_db_ping)
* @group Procedures
*/
export declare function ping(): CypherProcedure<"success">;
/**
* @see [Neo4j Documentation](https://neo4j.com/docs/operations-manual/current/reference/procedures/#procedure_db_propertykeys)
* @group Procedures
*/
export declare function propertyKeys(): CypherProcedure<"propertyKey">;
/**
* @see [Neo4j Documentation](https://neo4j.com/docs/operations-manual/current/reference/procedures/#procedure_db_relationshiptypes)
* @group Procedures
*/
export declare function relationshipTypes(): CypherProcedure<"relationshipType">;
/**
* @see [Neo4j Documentation](https://neo4j.com/docs/operations-manual/current/reference/procedures/#procedure_db_resampleindex)
* @group Procedures
*/
export declare function resampleIndex(): CypherProcedure<"indexName">;
/**
* @see [Neo4j Documentation](https://neo4j.com/docs/operations-manual/current/reference/procedures/#procedure_db_resampleoutdatedindexes)
* @group Procedures
*/
export declare function resampleOutdatedIndexes(): VoidCypherProcedure;