package anki.import_export

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc ImportCollectionPackage (ImportCollectionPackageRequest, generic.Empty)

  import_export.proto:16

  message ImportCollectionPackageRequest

  import_export.proto:30

  • string col_path = 1

  • string backup_path = 2

  • string media_folder = 3

  • string media_db = 4

• rpc ExportCollectionPackage (ExportCollectionPackageRequest, generic.Empty)

  import_export.proto:18

  message ExportCollectionPackageRequest

  import_export.proto:37

  • string out_path = 1

  • bool include_media = 2

  • bool legacy = 3

• rpc ImportAnkiPackage (ImportAnkiPackageRequest, ImportResponse)

  import_export.proto:20

  message ImportAnkiPackageRequest

  import_export.proto:43

  • string package_path = 1

• rpc ExportAnkiPackage (ExportAnkiPackageRequest, generic.UInt32)

  import_export.proto:21

  message ExportAnkiPackageRequest

  import_export.proto:70

  • string out_path = 1

  • bool with_scheduling = 2

  • bool with_media = 3

  • bool legacy = 4

  • optional ExportLimit limit = 5

• rpc GetCsvMetadata (CsvMetadataRequest, CsvMetadata)

  import_export.proto:22

  message CsvMetadataRequest

  import_export.proto:113

  • string path = 1

  • optional CsvMetadata.Delimiter delimiter = 2

  • optional int64 notetype_id = 3

  • optional bool is_html = 4

• rpc ImportCsv (ImportCsvRequest, ImportResponse)

  import_export.proto:23

  message ImportCsvRequest

  import_export.proto:108

  • string path = 1

  • optional CsvMetadata metadata = 2

• rpc ExportNoteCsv (ExportNoteCsvRequest, generic.UInt32)

  import_export.proto:24

  message ExportNoteCsvRequest

  import_export.proto:184

  • string out_path = 1

  • bool with_html = 2

  • bool with_tags = 3

  • bool with_deck = 4

  • bool with_notetype = 5

  • bool with_guid = 6

  • optional ExportLimit limit = 7

• rpc ExportCardCsv (ExportCardCsvRequest, generic.UInt32)

  import_export.proto:25

  message ExportCardCsvRequest

  import_export.proto:178

  • string out_path = 1

  • bool with_html = 2

  • optional ExportLimit limit = 3

• rpc ImportJsonFile (generic.String, ImportResponse)

  import_export.proto:26

• rpc ImportJsonString (generic.String, ImportResponse)

  import_export.proto:27

Column indices are 1-based to make working with them in TS easier, where unset numerical fields default to 0.

Used as response type in: ImportExportService.GetCsvMetadata

Used as field type in: ImportCsvRequest

• CsvMetadata.Delimiter delimiter = 1

• bool is_html = 2

• repeated string global_tags = 3

• repeated string updated_tags = 4

• repeated string column_labels = 5

  Column names as defined by the file or empty strings otherwise. Also used to determine the number of columns.

• oneof deck

  • int64 deck_id = 6

  • uint32 deck_column = 7

    One-based. 0 means n/a.

• oneof notetype

  • CsvMetadata.MappedNotetype global_notetype = 8

    One notetype for all rows with given column mapping.

  • uint32 notetype_column = 9

    Row-specific notetypes with automatic mapping by index. One-based. 0 means n/a.

• uint32 tags_column = 10

  One-based. 0 means n/a.

• bool force_delimiter = 11

• bool force_is_html = 12

• repeated generic.StringList preview = 13

• uint32 guid_column = 14

• CsvMetadata.DupeResolution dupe_resolution = 15

• CsvMetadata.MatchScope match_scope = 16

Order roughly in ascending expected frequency in note text, because the delimiter detection algorithm is stupidly picking the first one it encounters.

Used in: CsvMetadata, CsvMetadataRequest

• TAB = 0

• PIPE = 1

• SEMICOLON = 2

• COLON = 3

• COMMA = 4

• SPACE = 5

Used in: CsvMetadata, ImportResponse.Log

• UPDATE = 0

• PRESERVE = 1

• DUPLICATE = 2

  UPDATE_IF_NEWER = 3;

Used in: CsvMetadata

• int64 id = 1

• repeated uint32 field_columns = 2

  Source column indices for note fields. One-based. 0 means n/a.

Used in: CsvMetadata

• NOTETYPE = 0

• NOTETYPE_AND_DECK = 1

Used in: ExportAnkiPackageRequest, ExportCardCsvRequest, ExportNoteCsvRequest

• oneof limit

  • generic.Empty whole_collection = 1

  • int64 deck_id = 2

  • notes.NoteIds note_ids = 3

  • cards.CardIds card_ids = 4

Used as response type in: ImportExportService.ImportAnkiPackage, ImportExportService.ImportCsv, ImportExportService.ImportJsonFile, ImportExportService.ImportJsonString

• optional collection.OpChanges changes = 1

• optional ImportResponse.Log log = 2

Used in: ImportResponse

• repeated Note new = 1

• repeated Note updated = 2

• repeated Note duplicate = 3

• repeated Note conflicting = 4

• repeated Note first_field_match = 5

• repeated Note missing_notetype = 6

• repeated Note missing_deck = 7

• repeated Note empty_first_field = 8

• CsvMetadata.DupeResolution dupe_resolution = 9

• uint32 found_notes = 10

  Usually the sum of all queues, but may be lower if multiple duplicates have been updated with the same note.

Used in: Log

• optional notes.NoteId id = 1

• repeated string fields = 2

• repeated MediaEntries.MediaEntry entries = 1

Used in: MediaEntries

• string name = 1

• uint32 size = 2

• bytes sha1 = 3

• optional uint32 legacy_zip_filename = 255

  / Legacy media maps may include gaps in the media list, so the original / file index is recorded when importing from a HashMap. This field is not / set when exporting.

• PackageMetadata.Version version = 1

Used in: PackageMetadata

• VERSION_UNKNOWN = 0

• VERSION_LEGACY_1 = 1

  When `meta` missing, and collection.anki2 file present.

• VERSION_LEGACY_2 = 2

  When `meta` missing, and collection.anki21 file present.

• VERSION_LATEST = 3

  Implies MediaEntry media map, and zstd compression. collection.21b file