Excel

Important: Excel can only be used as a source or as a diff destination, not as a sync destination.

Source Configuration

sources:
  - name: src
    type: Excel
    connection:
      path: "path/to/excel.xlsx"

Sync Settings

The Excel source does not have any sync settings and can be left empty.

sync:
  - source: src
    sourceConfig:
      # type: dict[str, str], optional.
      # Overrides the type that a column would otherwise be automatically identified as.
      # Is a dictionary where the key is a column name and the value is a valid PolarType.
      # See sources > types > polar datatypes for allowed types.
      types:
        first_name: String
        age: Int8

      # type: string, optional.
      # Identifies what sheet should be read from the excel file.
      # Defaults to the first sheet of the file.
      sheet_name: 'students'

Diff settings

Configure the diff config as following.

sync:
  - name: test
    source: srcname
    destination: dstname
    sourceConfig: {}
    destinationConfig: {}
    diff:
      destination: 
        # type: string
        # Identifies the type of diff destination to use
        type: Excel
        # name: string
        # Points to a destination defined in the sources section by name
        name: diffsourcename
        # config: dict
        # The destination type specific configuration
        # The excel source does not have any specific config
        config: {}

The file will be automatically created if it doesn't exist. Otherwise beetl will read its contents and extend it.