Database
database
¶
This module defines handles the database connection through the
get_db
context manager.
get_db()
¶
Context-managed SQLAlchemy
session providing access to the database
Yields:
Name | Type | Description |
---|---|---|
Session |
Session
|
|
Raises:
Type | Description |
---|---|
EnvironmentError
|
If the |
Source code in kotobase/src/kotobase/db/database.py
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
|
build_database
¶
This module defines the click command which builds the kotobase.db
database
using SQLAlchemy.
build(force)
¶
Downloads source files, processes, and builds the Kotobase database.
Source code in kotobase/src/kotobase/db_builder/build_database.py
293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 |
|
create_database()
¶
Click command helper which creates the database and all tables.
Source code in kotobase/src/kotobase/db_builder/build_database.py
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 |
|
populate_jlpt(session)
¶
Click command helper which populates JLPT tables in the database.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session
|
Session
|
SQLAlchemy Session object |
required |
Source code in kotobase/src/kotobase/db_builder/build_database.py
247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 |
|
populate_jmdict(session)
¶
Click command helper which populates JMDict tables in the database.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session
|
Session
|
SQLAlchemy Session object |
required |
Source code in kotobase/src/kotobase/db_builder/build_database.py
69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
|
populate_jmnedict(session)
¶
Click command helper which populates JMNeDict tables in the database.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session
|
Session
|
SQLAlchemy Session object |
required |
Source code in kotobase/src/kotobase/db_builder/build_database.py
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 |
|
populate_kanjidic(session)
¶
Click command helper which populates KANJIDIC table in the database.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session
|
Session
|
SQLAlchemy Session object |
required |
Source code in kotobase/src/kotobase/db_builder/build_database.py
173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 |
|
populate_tatoeba(session)
¶
Click command helper which populates Tatoeba table in the database.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
session
|
Session
|
SQLAlchemy Session object |
required |
Source code in kotobase/src/kotobase/db_builder/build_database.py
222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 |
|
download
¶
This module defines the helper function which downloads the zipped source files and extracts their content for processing.
download_and_extract(url, output_filename)
¶
Click command helper which downloads a file from an URL and extracts it if it is compressed.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
url
|
str
|
File download URL |
required |
output_filename
|
str
|
Path of where to save the file. |
required |
Source code in kotobase/src/kotobase/db_builder/download.py
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 |
|
main()
¶
Main download function to download all data sources
from URLs specified in the config
module.
Source code in kotobase/src/kotobase/db_builder/download.py
85 86 87 88 89 90 91 92 93 94 |
|
process_jmdict
¶
This module defines the helper function which processes the raw JMDict XML file into a JSON file using XSLT transform for performance.
parse_jmdict()
¶
Click helper function which parses JMdict_e.xml and saves it as a JSON file using an embedded XSLT.
Source code in kotobase/src/kotobase/db_builder/process_jmdict.py
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
|
process_jmnedict
¶
This module defines the helper function which processes the raw JMNeDict XML file into a JSON file using XSLT transform for performance.
parse_jmnedict()
¶
Click helper function which parses JMNedict_e.xml and saves it as a JSON file using an embedded XSLT.
Source code in kotobase/src/kotobase/db_builder/process_jmnedict.py
76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 |
|
process_kanjidic
¶
This module defines the helper function which processes the raw KANJIDIC2 XML file into a JSON
parse_kanjidic()
¶
Click helper function which parses kanjidic.xml and saves it as a JSON file.
Source code in kotobase/src/kotobase/db_builder/process_kanjidic.py
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
|
process_tatoeba
¶
This module defines the helper function which processes the raw Tatoeba Examples tsv file into a JSON
parse_tatoeba()
¶
Click helper function which parses tatoeba.tsv and saves it as a JSON file.
Source code in kotobase/src/kotobase/db_builder/process_tatoeba.py
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
|
pull
¶
This module defines the click command which pulls a pre-built database from a public Google Drive folder.
pull_db(force)
¶
Downloads the latest Kotobase database from Google Drive.
Source code in kotobase/src/kotobase/db_builder/pull.py
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 |
|