org.neo4j.cypher.internal.expressions.functions.GraphByElementId.scala Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of neo4j-expressions Show documentation

Cypher expressions

The newest version!

/*
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * 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 org.neo4j.cypher.internal.expressions.functions

import org.neo4j.cypher.internal.expressions.FunctionTypeSignature
import org.neo4j.cypher.internal.util.symbols.CTGraphRef
import org.neo4j.cypher.internal.util.symbols.CTString

object GraphByElementId extends Function {
  def name: String = "graph.byElementId"

  override val signatures = Vector(
    FunctionTypeSignature(
      this,
      CTGraphRef,
      Vector("elementId"),
      "Returns the graph reference with the given element id. It is only supported in the `USE` clause, on composite databases.",
      Category.GRAPH,
      Vector(CTString)
    )
  )
}