Documentation for table.pks, closes #116

simonw · Jun 23, 2020 · fbeb61e · fbeb61e
1 parent 4d9a320
commit fbeb61e
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/docs/python-api.rst b/docs/python-api.rst
@@ -1020,6 +1020,11 @@ The ``.columns_dict`` property returns a dictionary version of this with just th
     >>> db["PlantType"].columns_dict
     {'id': <class 'int'>, 'value': <class 'str'>}
 
+The ``.pks`` property returns a list of strings naming the primary key columns for the table::
+
+    >>> db["PlantType"].pks
+    ['id']
+
 The ``.foreign_keys`` property shows if the table has any foreign key relationships. It is not available on views.
 
 ::