Skip to content

CreateTable

Description

      description: |
        Create table `id` in the namespace with the given data in Arrow IPC stream.

        The schema of the Arrow IPC stream is used as the table schema.    
        If the stream is empty, the API creates a new empty table.

Request Schema

    CreateTableRequest:
      type: object
      description: |
        Request for creating a table, excluding the Arrow IPC stream.
      properties:
        id:
          type: array
          items:
            type: string
        location:
          type: string
        mode:
          type: string
          description: |
            There are three modes when trying to create a table,
            to differentiate the behavior when a table of the same name already exists:
              * create: the operation fails with 409.
              * exist_ok: the operation succeeds and the existing table is kept.
              * overwrite: the existing table is dropped and a new table with this name is created.
          enum:
            - create
            - exist_ok
            - overwrite
        properties:
          type: object
          additionalProperties:
            type: string

Response Schema

    CreateTableResponse:
      type: object
      properties:
        location:
          type: string
        version:
          type: integer
          format: int64
          minimum: 0
        properties:
          type: object
          additionalProperties:
            type: string
        storage_options:
          type: object
          description: |
            Configuration options to be used to access storage. The available
            options depend on the type of storage in use. These will be
            passed directly to Lance to initialize storage access.
          additionalProperties:
            type: string