.. _Property:

########################
Property Documentation
########################

put_property_value
======================
设置某个点或边的某属性值。


**函数声明**

.. code:: python

  def put_property_value(self, is_vertex: bool, id: Union[str, int], property_name: str, value: Any, is_merge: bool) -> None

**参数说明**

=============================    =============================    =====================    =================================================================================================================
**Parameter**                    **Optional**                     **Type**                 **DESC**
is_vertex                        Y                                bool                     点类型填True，边类型填False，**is_vertex需要跟id对应。**
id                               Y                                int, str                 点id或边id，**不能为空，如果是点id不能小于0，如果是边id格式需要符合长度等于32和16进制规范。**
property_name                    Y                                str                      属性名，**不能为空。**
value                            Y                                str                      属性值，**不能为空。**
is_merge                         Y                                bookl                    为true时集合属性追加，为fasle属性覆盖
=============================    =============================    =====================    =================================================================================================================

**异常**

=====================================================    =====================================================================================
**Type**                                                 **DESC**
ParamException                                           参数格式不正确，当点id或边id格式不正确、属性名为空或属性值为空时将抛出异常。
VertexNotFoundException                                  点在图中不存在时将抛出异常。
EdgeNotFoundException                                    边在图中不存在时将抛出异常。
PropertyNotFoundException                                属性名在对应类型中不存在时将抛出异常。
ValueFormatException                                     value类型转换失败时将抛出异常。
DatabaseException                                        数据库内部异常。
=====================================================    =====================================================================================

**示例**

.. code:: python

  graph.put_property_value(True, 0, "age", 28, True)

remove_property_value
===========================
删除属性值。


**函数声明**

.. code:: python

  def remove_property_value(self, is_vertex: bool, id: Union[str, int], property_name: str) -> None:

**参数说明**

=============================    =============================    =====================    =============================================================================================================
**Parameter**                    **Optional**                     **Type**                 **DESC**
is_vertex                        Y                                bool                     点类型填True，边类型填False，**is_vertex需要跟id对应。**
id                               Y                                int, str                 点/边id，**不能为空，如果是点id不能小于0，如果是边id格式需要符合长度等于32和16进制规范。**
property_name                    Y                                str                      属性名，**不能为空。**
=============================    =============================    =====================    =============================================================================================================

**异常**

=====================================================    =====================================================================
**Type**                                                 **DESC**
ParamException                                           参数格式不正确，当点/边id格式不正确、属性名为空时将抛出异常。
VertexNotFoundException                                  点在图中不存在时将抛出异常。
EdgeNotFoundException                                    边在图中不存在时将抛出异常。
PropertyNotFoundException                                属性名在对应点/边中不存在时将抛出异常。
DatabaseException                                        数据库内部异常
=====================================================    =====================================================================

**示例**

.. code:: python

  graph.remove_property_value(True, 0, "age")