fixes #10

Author: jph00

README.md

@@ -15,7 +15,6 @@ to be particularly of interest to folks using Jupyter.
 ## Overview
 
 ``` python
-from sqlite_utils import Database
 from fastlite import *
 from fastcore.utils import *
 from fastcore.net import urlsave
@@ -29,7 +28,7 @@ url = 'https://github.com/lerocha/chinook-database/raw/master/ChinookDatabase/Da
 path = Path('chinook.sqlite')
 if not path.exists(): urlsave(url, path)
 
-db = Database("chinook.sqlite")
+db = database("chinook.sqlite")
 ```
 
 Databases have a `t` property that lists all tables:
@@ -171,9 +170,11 @@ to a module, which you can then import from:
 create_mod(db, 'db_dc')
 ```
 
+Indexing into a table does a query on primary key:
+
 ``` python
 from db_dc import Track
-Track(**dt.Track.get(1))
+Track(**dt.Track[1])
 ```
 
     Track(TrackId=1, Name='For Those About To Rock (We Salute You)', AlbumId=1, MediaTypeId=1, GenreId=1, Composer='Angus Young, Malcolm Young, Brian Johnson', Milliseconds=343719, Bytes=11170334, UnitPrice=0.99)
@@ -190,35 +191,46 @@ album(limit=2)
     [Album(AlbumId=1, Title='For Those About To Rock We Salute You', ArtistId=1),
      Album(AlbumId=2, Title='Balls to the Wall', ArtistId=2)]
 
-Pass a truthy value as the first param and you’ll get tuples of primary
-keys and records:
+Pass a truthy value as `with_pk` and you’ll get tuples of primary keys
+and records:
 
 ``` python
-album(1, limit=2)
+album(with_pk=1, limit=2)
 ```
 
     [(1,
       Album(AlbumId=1, Title='For Those About To Rock We Salute You', ArtistId=1)),
      (2, Album(AlbumId=2, Title='Balls to the Wall', ArtistId=2))]
 
-`get` also uses the dataclass by default:
+Indexing also uses the dataclass by default:
 
 ``` python
-album.get(1)
+album[5]
 ```
 
-    Album(AlbumId=1, Title='For Those About To Rock We Salute You', ArtistId=1)
+    Album(AlbumId=5, Title='Big Ones', ArtistId=3)
+
+If you set `xtra` fields, then indexing is also filtered by those. As a
+result, for instance in this case, nothing is returned since album 5 is
+not created by artist 1:
+
+``` python
+album.xtra(ArtistId=1)
+
+try: album[5]
+except NotFoundError: print("Not found")
+```
 
-If you want the dataclass-conversion behaviour for *all* tables (and
-optionally views) then you can create them all at once with
-[`all_dcs`](https://AnswerDotAI.github.io/fastlite/core.html#all_dcs).
+    Not found
+
+The same filtering is done when using the table as a callable:
 
 ``` python
-dcs = all_dcs(db)
-dcs[0]
+album()
 ```
 
-    types.Album
+    [Album(AlbumId=1, Title='For Those About To Rock We Salute You', ArtistId=1),
+     Album(AlbumId=4, Title='Let There Be Rock', ArtistId=1)]
 
 ## Insert, upsert, and update
 
@@ -233,56 +245,90 @@ The following methods accept `**kwargs`, passing them along to the first
 - `upsert`
 - `lookup`
 
+We can access a table that doesn’t actually exist yet:
+
 ``` python
 cats = dt.cats
-cats.create(id=int, name=str, weight=float, pk='id')
+cats
+```
+
+    <Table cats (does not exist yet)>
+
+We can use keyword arguments to now create that table:
+
+``` python
+cats.create(id=int, name=str, weight=float, uid=int, pk='id')
 hl_md(cats.schema, 'sql')
 ```
 
 ``` sql
 CREATE TABLE [cats] (
    [id] INTEGER PRIMARY KEY,
    [name] TEXT,
-   [weight] FLOAT
+   [weight] FLOAT,
+   [uid] INTEGER
 )
 ```
 
-…the same applies to `insert` here:
+It we set `xtra` then the additional fields are used for `insert`,
+`update`, and `delete`:
 
 ``` python
+cats.xtra(uid=2)
 cat = cats.insert(name='meow', weight=6)
 ```
 
-The inserted row is returned.
+The inserted row is returned, including the xtra ‘uid’ field.
 
 ``` python
 cat
 ```
 
-    {'id': 1, 'name': 'meow', 'weight': 6.0}
+    {'id': 1, 'name': 'meow', 'weight': 6.0, 'uid': 2}
 
-Using `**` in upsert here doesn’t actually achieve anything, since we
+Using `**` in `update` here doesn’t actually achieve anything, since we
 can just pass a `dict` directly – it’s just to show that it works:
 
 ``` python
 cat['name'] = "moo"
-cats.upsert(**cat)
+cat['uid'] = 1
+cats.update(**cat)
 cats()
 ```
 
-    [{'id': 1, 'name': 'moo', 'weight': 6.0}]
+    [{'id': 1, 'name': 'moo', 'weight': 6.0, 'uid': 2}]
+
+Attempts to update or insert with xtra fields are ignored.
+
+An error is raised if there’s an attempt to update a record not matching
+`xtra` fields:
+
+``` python
+cats.xtra(uid=1)
+try: cats.update(**cat)
+except NotFoundError: print("Not found")
+```
+
+    Not found
 
 This all also works with dataclasses:
 
 ``` python
-catdc = cats.dataclass()
-cat = cats.get(1)
+cats.xtra(uid=2)
+cats.dataclass()
+cat = cats[1]
+cat
+```
+
+    Cats(id=1, name='moo', weight=6.0, uid=2)
+
+``` python
 cat.name = 'foo'
 cats.upsert(cat)
 cats()
 ```
 
-    [Cats(id=1, name='foo', weight=6.0)]
+    [Cats(id=1, name='foo', weight=6.0, uid=2)]
 
 ``` python
 cats.drop()
@@ -299,7 +345,7 @@ If you have graphviz installed, you can create database diagrams:
 diagram(db.tables)
 ```
 
-![](index_files/figure-commonmark/cell-27-output-1.svg)
+![](index_files/figure-commonmark/cell-31-output-1.svg)
 
 Pass a subset of tables to just diagram those. You can also adjust the
 size and aspect ratio.
@@ -308,4 +354,4 @@ size and aspect ratio.
 diagram(db.t['Artist','Album','Track','Genre','MediaType'], size=8, ratio=0.4)
 ```
 
-![](index_files/figure-commonmark/cell-28-output-1.svg)
+![](index_files/figure-commonmark/cell-32-output-1.svg)

fastlite/_modidx.py

@@ -17,6 +17,7 @@
                                'fastlite.core.View.c': ('core.html#view.c', 'fastlite/core.py'),
                                'fastlite.core._Col': ('core.html#_col', 'fastlite/core.py'),
                                'fastlite.core._Col.__init__': ('core.html#_col.__init__', 'fastlite/core.py'),
+                               'fastlite.core._Col.__iter__': ('core.html#_col.__iter__', 'fastlite/core.py'),
                                'fastlite.core._Col.__repr__': ('core.html#_col.__repr__', 'fastlite/core.py'),
                                'fastlite.core._Col.__str__': ('core.html#_col.__str__', 'fastlite/core.py'),
                                'fastlite.core._ColsGetter': ('core.html#_colsgetter', 'fastlite/core.py'),

fastlite/core.py

@@ -10,7 +10,7 @@
 from fastcore.utils import *
 from fastcore.xml import highlight
 from fastcore.xtras import hl_md, dataclass_src
-from sqlite_utils.db import *
+from sqlite_minutils.db import *
 
 try: from graphviz import Source
 except ImportError: pass
@@ -40,6 +40,7 @@ class _Col:
     def __init__(self, t, c): self.t,self.c = t,c
     def __str__(self):  return f'"{self.t}"."{self.c}"'
     def __repr__(self):  return self.c
+    def __iter__(self): return iter(self.c)
 
 class _ColsGetter:
     def __init__(self, tbl): self.tbl = tbl

fastlite/kw.py

@@ -1,7 +1,7 @@
 from dataclasses import is_dataclass, MISSING, asdict
 from typing import Any,Union,Tuple,List,Iterable
 from fastcore.utils import *
-from sqlite_utils.db import Database,Table,DEFAULT,ForeignKeysType,Default,Queryable,NotFoundError
+from sqlite_minutils.db import Database,Table,DEFAULT,ForeignKeysType,Default,Queryable,NotFoundError
 
 opt_bool = Union[bool, Default, None]
 

nbs/00_core.ipynb

@@ -38,7 +38,7 @@
     "from fastcore.utils import *\n",
     "from fastcore.xml import highlight\n",
     "from fastcore.xtras import hl_md, dataclass_src\n",
-    "from sqlite_utils.db import *\n",
+    "from sqlite_minutils.db import *\n",
     "\n",
     "try: from graphviz import Source\n",
     "except ImportError: pass"
@@ -187,6 +187,7 @@
     "    def __init__(self, t, c): self.t,self.c = t,c\n",
     "    def __str__(self):  return f'\"{self.t}\".\"{self.c}\"'\n",
     "    def __repr__(self):  return self.c\n",
+    "    def __iter__(self): return iter(self.c)\n",
     "\n",
     "class _ColsGetter:\n",
     "    def __init__(self, tbl): self.tbl = tbl\n",

nbs/index.ipynb

@@ -69,7 +69,7 @@
     "path = Path('chinook.sqlite')\n",
     "if not path.exists(): urlsave(url, path)\n",
     "\n",
-    "db = Database(\"chinook.sqlite\")"
+    "db = database(\"chinook.sqlite\")"
    ]
   },
   {

settings.ini

@@ -5,7 +5,7 @@ version = 0.0.5
 min_python = 3.10
 license = apache2
 black_formatting = False
-requirements = fastcore>=1.5.41 sqlite-utils
+requirements = fastcore>=1.5.41 sqlite-minutils
 conda_user = fastai
 doc_path = _docs
 lib_path = fastlite