Implement tables.add rpc endpoint

db/tables/operations/create.py

@@ -1,7 +1,7 @@
 from sqlalchemy.ext import compiler
 from sqlalchemy.schema import DDLElement
 import json
-from db.connection import execute_msar_func_with_engine
+from db.connection import execute_msar_func_with_engine, exec_msar_func
 from db.types.base import PostgresType
 from db.tables.operations.select import reflect_table_from_oid
 from db.metadata import get_empty_metadata
@@ -33,6 +33,38 @@ def create_mathesar_table(engine, table_name, schema_oid, columns=[], constraint
     ).fetchone()[0]
 
 
+def create_table_on_database(
+    table_name,
+    schema_oid,
+    conn,
+    column_data_list=[],
+    constraint_data_list=[],
+    comment=None
+):
+    """
+    Creates a table with a default id column.
+
+    Args:
+        table_name: Name of the table to be created.
+        schema_oid: The OID of the schema where the table will be created.
+        columns: The columns dict for the new table, in order. (optional)
+        constraints: The constraints dict for the new table. (optional)
+        comment: The comment for the new table. (optional)
+
+    Returns:
+        Returns the OID of the created table.
+    """
+    return exec_msar_func(
+        conn,
+        'add_mathesar_table',
+        schema_oid,
+        table_name,
+        json.dumps(column_data_list),
+        json.dumps(constraint_data_list),
+        comment
+    ).fetchone()[0]
+
+
 # TODO stop relying on reflections, instead return oid of the created table.
 def create_string_column_table(name, schema_oid, column_names, engine, comment=None):
     """

docs/docs/api/rpc.md

@@ -61,7 +61,8 @@ To use an RPC function:
     options:
       members:
       - list_
-      - get_
+      - get
+      - add
       - delete
       - TableInfo
 

mathesar/rpc/columns.py

@@ -74,6 +74,28 @@ def from_dict(cls, col_default):
             )
 
 
+class CreateableColumnInfo(TypedDict):
+    """
+    Information about adding a new column.
+
+    Only the `name` & `type` keys are required.
+
+    Attributes:
+        name: The name of the column.
+        type: The type of the column on the database.
+        type_options: The options applied to the column type.
+        nullable: Whether or not the column is nullable.
+        default: The default value.
+        description: The description of the column.
+    """
+    name: str
+    type: str
+    type_options: Optional[TypeOptions]
+    nullable: Optional[bool]
+    default: Optional[ColumnDefault]
+    description: Optional[str]
+
+
 class SettableColumnInfo(TypedDict):
     """
     Information about a column, restricted to settable fields.

mathesar/rpc/constraints.py

@@ -0,0 +1,8 @@
+"""
+Classes and functions exposed to the RPC endpoint for managing table constraints.
+"""
+from typing import TypedDict
+
+
+class CreateableConstraintInfo(TypedDict):
+    pass

mathesar/rpc/tables.py

@@ -5,6 +5,9 @@
 
 from db.tables.operations.select import get_table_info, get_table
 from db.tables.operations.drop import drop_table_from_database
+from db.tables.operations.create import create_table_on_database
+from mathesar.rpc.columns import CreateableColumnInfo
+from mathesar.rpc.constraints import CreateableConstraintInfo
 from mathesar.rpc.exceptions.handlers import handle_rpc_exceptions
 from mathesar.rpc.utils import connect
 
@@ -67,6 +70,41 @@ def get(*, table_oid: int, database_id: int, **kwargs) -> TableInfo:
     return TableInfo(raw_table_info)
 
 
+@rpc_method(name="tables.add")
+@http_basic_auth_login_required
+@handle_rpc_exceptions
+def add(
+    *,
+    table_name: str,
+    schema_oid: int,
+    database_id: int,
+    column_data_list: list[CreateableColumnInfo] = [],
+    constraint_data_list: list[CreateableConstraintInfo] = [],
+    comment: str = None,
+    **kwargs
+) -> int:
+    """
+    Add a table with a default id column.
+
+    Args:
+        table_name: Name of the table to be created.
+        schema_oid: Identity of the schema in the user's database.
+        database_id: The Django id of the database containing the table.
+        column_data_list: A list describing columns to be created for the new table, in order.
+        constraint_data_list: A list describing constraints to be created for the new table.
+        comment: The comment for the new table.
+
+    Returns:
+        The `oid` of the created table.
+    """
+    user = kwargs.get(REQUEST_KEY).user
+    with connect(database_id, user) as conn:
+        created_table_oid = create_table_on_database(
+            table_name, schema_oid, conn, column_data_list, constraint_data_list, comment
+        )
+    return created_table_oid
+
+
 @rpc_method(name="tables.delete")
 @http_basic_auth_login_required
 @handle_rpc_exceptions

mathesar/tests/rpc/test_endpoints.py

@@ -59,6 +59,11 @@
         "tables.get",
         [user_is_authenticated]
     ),
+    (
+        tables.add,
+        "tables.add",
+        [user_is_authenticated]
+    ),
     (
         tables.delete,
         "tables.delete",

mathesar/tests/rpc/test_tables.py

@@ -126,3 +126,29 @@ def mock_drop_table(_table_oid, conn, cascade):
     monkeypatch.setattr(tables, 'drop_table_from_database', mock_drop_table)
     deleted_table = tables.delete(table_oid=1964474, database_id=11, request=request)
     assert deleted_table == 'public."Table 0"'
+
+
+def test_tables_add(rf, monkeypatch):
+    request = rf.post('/api/rpc/v0', data={})
+    request.user = User(username='alice', password='pass1234')
+    schema_oid = 2200
+    database_id = 11
+
+    @contextmanager
+    def mock_connect(_database_id, user):
+        if _database_id == database_id and user.username == 'alice':
+            try:
+                yield True
+            finally:
+                pass
+        else:
+            raise AssertionError('incorrect parameters passed')
+
+    def mock_table_add(table_name, _schema_oid, conn, column_data_list, constraint_data_list, comment):
+        if _schema_oid != schema_oid:
+            raise AssertionError('incorrect parameters passed')
+        return 1964474
+    monkeypatch.setattr(tables, 'connect', mock_connect)
+    monkeypatch.setattr(tables, 'create_table_on_database', mock_table_add)
+    actual_table_oid = tables.add(table_name='newtable', schema_oid=2200, database_id=11, request=request)
+    assert actual_table_oid == 1964474