IndexSpecBuilder

Bases: object

__new__(graph)

Create and return a new object. See help(type) for accurate signature.

build()

Return a spec

Returns:

Type	Description
IndexSpec

with_all_edge_metadata()

Adds all edge metadata to the spec.

Returns:

Type	Description
dict[str, Any]

with_all_edge_properties()

Adds all edge properties to the spec.

Returns:

Type	Description
dict[str, Any]

with_all_edge_properties_and_metadata()

Adds all edge properties and metadata to the spec.

Returns:

Type	Description
dict[str, Any]

with_all_node_metadata()

Adds all node metadata to the spec.

Returns:

Type	Description
dict[str, Any]

with_all_node_properties()

Adds all node properties to the spec.

Returns:

Type	Description
dict[str, Any]

with_all_node_properties_and_metadata()

Adds all node properties and metadata to the spec.

Returns:

Type	Description
dict[str, Any]

with_edge_metadata(props)

Adds specified edge metadata to the spec.

Parameters:

Name	Type	Description	Default
props	Any	List of metadata.	required

Returns:

Type	Description
dict[str, Any]

with_edge_properties(props)

Adds specified edge properties to the spec.

Parameters:

Name	Type	Description	Default
props	Any	List of properties.	required

Returns:

Type	Description
dict[str, Any]

with_node_metadata(props)

Adds specified node metadata to the spec.

Parameters:

Name	Type	Description	Default
props	Any	list of metadata.	required

Returns:

Type	Description
dict[str, Any]

with_node_properties(props)

Adds specified node properties to the spec.

Parameters:

Name	Type	Description	Default
props	Any	list of properties.	required

Returns:

Type	Description
dict[str, Any]