\documentclass[10pt,a4paper]{article} % Packages \usepackage{fancyhdr} % For header and footer \usepackage{multicol} % Allows multicols in tables \usepackage{tabularx} % Intelligent column widths \usepackage{tabulary} % Used in header and footer \usepackage{hhline} % Border under tables \usepackage{graphicx} % For images \usepackage{xcolor} % For hex colours %\usepackage[utf8x]{inputenc} % For unicode character support \usepackage[T1]{fontenc} % Without this we get weird character replacements \usepackage{colortbl} % For coloured tables \usepackage{setspace} % For line height \usepackage{lastpage} % Needed for total page number \usepackage{seqsplit} % Splits long words. %\usepackage{opensans} % Can't make this work so far. Shame. Would be lovely. \usepackage[normalem]{ulem} % For underlining links % Most of the following are not required for the majority % of cheat sheets but are needed for some symbol support. \usepackage{amsmath} % Symbols \usepackage{MnSymbol} % Symbols \usepackage{wasysym} % Symbols %\usepackage[english,german,french,spanish,italian]{babel} % Languages % Document Info \author{Lewis Eason (lewiseason)} \pdfinfo{ /Title (django-models.pdf) /Creator (Cheatography) /Author (Lewis Eason (lewiseason)) /Subject (Django Models Cheat Sheet) } % Lengths and widths \addtolength{\textwidth}{6cm} \addtolength{\textheight}{-1cm} \addtolength{\hoffset}{-3cm} \addtolength{\voffset}{-2cm} \setlength{\tabcolsep}{0.2cm} % Space between columns \setlength{\headsep}{-12pt} % Reduce space between header and content \setlength{\headheight}{85pt} % If less, LaTeX automatically increases it \renewcommand{\footrulewidth}{0pt} % Remove footer line \renewcommand{\headrulewidth}{0pt} % Remove header line \renewcommand{\seqinsert}{\ifmmode\allowbreak\else\-\fi} % Hyphens in seqsplit % This two commands together give roughly % the right line height in the tables \renewcommand{\arraystretch}{1.3} \onehalfspacing % Commands \newcommand{\SetRowColor}[1]{\noalign{\gdef\RowColorName{#1}}\rowcolor{\RowColorName}} % Shortcut for row colour \newcommand{\mymulticolumn}[3]{\multicolumn{#1}{>{\columncolor{\RowColorName}}#2}{#3}} % For coloured multi-cols \newcolumntype{x}[1]{>{\raggedright}p{#1}} % New column types for ragged-right paragraph columns \newcommand{\tn}{\tabularnewline} % Required as custom column type in use % Font and Colours \definecolor{HeadBackground}{HTML}{333333} \definecolor{FootBackground}{HTML}{666666} \definecolor{TextColor}{HTML}{333333} \definecolor{DarkBackground}{HTML}{902BB5} \definecolor{LightBackground}{HTML}{F8F1FA} \renewcommand{\familydefault}{\sfdefault} \color{TextColor} % Header and Footer \pagestyle{fancy} \fancyhead{} % Set header to blank \fancyfoot{} % Set footer to blank \fancyhead[L]{ \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{C} \SetRowColor{DarkBackground} \vspace{-7pt} {\parbox{\dimexpr\textwidth-2\fboxsep\relax}{\noindent \hspace*{-6pt}\includegraphics[width=5.8cm]{/web/www.cheatography.com/public/images/cheatography_logo.pdf}} } \end{tabulary} \columnbreak \begin{tabulary}{11cm}{L} \vspace{-2pt}\large{\bf{\textcolor{DarkBackground}{\textrm{Django Models Cheat Sheet}}}} \\ \normalsize{by \textcolor{DarkBackground}{Lewis Eason (lewiseason)} via \textcolor{DarkBackground}{\uline{cheatography.com/6319/cs/1072/}}} \end{tabulary} \end{multicols}} \fancyfoot[L]{ \footnotesize \noindent \begin{multicols}{3} \begin{tabulary}{5.8cm}{LL} \SetRowColor{FootBackground} \mymulticolumn{2}{p{5.377cm}}{\bf\textcolor{white}{Cheatographer}} \\ \vspace{-2pt}Lewis Eason (lewiseason) \\ \uline{cheatography.com/lewiseason} \\ \uline{\seqsplit{lewiseason}.co.uk} \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Cheat Sheet}} \\ \vspace{-2pt}Published 31st May, 2013.\\ Updated 12th May, 2016.\\ Page {\thepage} of \pageref{LastPage}. \end{tabulary} \vfill \columnbreak \begin{tabulary}{5.8cm}{L} \SetRowColor{FootBackground} \mymulticolumn{1}{p{5.377cm}}{\bf\textcolor{white}{Sponsor}} \\ \SetRowColor{white} \vspace{-5pt} %\includegraphics[width=48px,height=48px]{dave.jpeg} Measure your website readability!\\ www.readability-score.com \end{tabulary} \end{multicols}} \begin{document} \raggedright \raggedcolumns % Set font size to small. Switch to any value % from this page to resize cheat sheet text: % www.emerson.emory.edu/services/latex/latex_169.html \footnotesize % Small font. \begin{multicols*}{3} \begin{tabularx}{5.377cm}{x{2.83689 cm} x{2.14011 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Field Types}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{AutoField} \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} \mymulticolumn{2}{x{5.377cm}}{BigIntegerField} \tn % Row Count 2 (+ 1) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{BinaryField} \tn % Row Count 3 (+ 1) % Row 3 \SetRowColor{white} \mymulticolumn{2}{x{5.377cm}}{BooleanField} \tn % Row Count 4 (+ 1) % Row 4 \SetRowColor{LightBackground} CharField & max\_length \tn % Row Count 5 (+ 1) % Row 5 \SetRowColor{white} \seqsplit{CommaSeparatedIntegerField} & max\_length \tn % Row Count 7 (+ 2) % Row 6 \SetRowColor{LightBackground} DateField & auto\_now \tn % Row Count 8 (+ 1) % Row 7 \SetRowColor{white} & auto\_now\_add \tn % Row Count 9 (+ 1) % Row 8 \SetRowColor{LightBackground} DateTimeField & (as above) \tn % Row Count 10 (+ 1) % Row 9 \SetRowColor{white} DecimalField & max\_digits \tn % Row Count 11 (+ 1) % Row 10 \SetRowColor{LightBackground} & decimal\_places \tn % Row Count 12 (+ 1) % Row 11 \SetRowColor{white} EmailField & max\_length \tn % Row Count 13 (+ 1) % Row 12 \SetRowColor{LightBackground} FileField & upload\_to \tn % Row Count 14 (+ 1) % Row 13 \SetRowColor{white} & storage \tn % Row Count 15 (+ 1) % Row 14 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{FloatField} \tn % Row Count 16 (+ 1) % Row 15 \SetRowColor{white} ImageField & upload\_to \tn % Row Count 17 (+ 1) % Row 16 \SetRowColor{LightBackground} & height\_field \tn % Row Count 18 (+ 1) % Row 17 \SetRowColor{white} & width\_field \tn % Row Count 19 (+ 1) % Row 18 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{IntegerField} \tn % Row Count 20 (+ 1) % Row 19 \SetRowColor{white} \mymulticolumn{2}{x{5.377cm}}{IPAddressField} \tn % Row Count 21 (+ 1) % Row 20 \SetRowColor{LightBackground} GenericIPAddressField & protocol \tn % Row Count 22 (+ 1) % Row 21 \SetRowColor{white} & unpack\_ipv4 \tn % Row Count 23 (+ 1) % Row 22 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{NullBooleanField} \tn % Row Count 24 (+ 1) % Row 23 \SetRowColor{white} \mymulticolumn{2}{x{5.377cm}}{PositiveIntegerField} \tn % Row Count 25 (+ 1) % Row 24 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{\seqsplit{PositiveSmallIntegerField}} \tn % Row Count 26 (+ 1) % Row 25 \SetRowColor{white} SlugField & max\_length \tn % Row Count 27 (+ 1) % Row 26 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{SmallIntegerField} \tn % Row Count 28 (+ 1) % Row 27 \SetRowColor{white} \mymulticolumn{2}{x{5.377cm}}{TextField} \tn % Row Count 29 (+ 1) % Row 28 \SetRowColor{LightBackground} TimeField & auto\_now \tn % Row Count 30 (+ 1) \end{tabularx} \par\addvspace{1.3em} \vfill \columnbreak \begin{tabularx}{5.377cm}{x{2.83689 cm} x{2.14011 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Field Types (cont)}} \tn % Row 29 \SetRowColor{LightBackground} & auto\_now\_add \tn % Row Count 1 (+ 1) % Row 30 \SetRowColor{white} URLField & max\_length \tn % Row Count 2 (+ 1) % Row 31 \SetRowColor{LightBackground} ForeignKey & model \tn % Row Count 3 (+ 1) % Row 32 \SetRowColor{white} & related\_name \tn % Row Count 4 (+ 1) % Row 33 \SetRowColor{LightBackground} & to\_field \tn % Row Count 5 (+ 1) % Row 34 \SetRowColor{white} & db\_constraint (True) \tn % Row Count 7 (+ 2) % Row 35 \SetRowColor{LightBackground} & on\_delete \tn % Row Count 8 (+ 1) % Row 36 \SetRowColor{white} ManyToManyField & model \tn % Row Count 9 (+ 1) % Row 37 \SetRowColor{LightBackground} & limit\_choices\_to \tn % Row Count 10 (+ 1) % Row 38 \SetRowColor{white} \mymulticolumn{2}{x{5.377cm}}{OneToOneField} \tn % Row Count 11 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Field Options}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{null} \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{blank} \tn % Row Count 2 (+ 1) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{choices} \tn % Row Count 3 (+ 1) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{db\_column} \tn % Row Count 4 (+ 1) % Row 4 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{db\_index} \tn % Row Count 5 (+ 1) % Row 5 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{db\_tablespace} \tn % Row Count 6 (+ 1) % Row 6 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{default} \tn % Row Count 7 (+ 1) % Row 7 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{editable} \tn % Row Count 8 (+ 1) % Row 8 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{error\_messages} \tn % Row Count 9 (+ 1) % Row 9 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{help\_text} \tn % Row Count 10 (+ 1) % Row 10 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{primary\_key} \tn % Row Count 11 (+ 1) % Row 11 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{unique} \tn % Row Count 12 (+ 1) % Row 12 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{unique\_for\_{[}date|month|year{]}} \tn % Row Count 13 (+ 1) % Row 13 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{verbose\_name} \tn % Row Count 14 (+ 1) % Row 14 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{validators} \tn % Row Count 15 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{x{2.78712 cm} x{2.18988 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Field Lookups}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{\_\_exact} \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} \_\_iexact & Case Insensitive \tn % Row Count 2 (+ 1) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{\_\_contains} \tn % Row Count 3 (+ 1) % Row 3 \SetRowColor{white} \mymulticolumn{2}{x{5.377cm}}{\_\_icontains} \tn % Row Count 4 (+ 1) % Row 4 \SetRowColor{LightBackground} \_\_in & Pass in a list \tn % Row Count 5 (+ 1) % Row 5 \SetRowColor{white} \_\_gt, \_\_gte, \_\_lt, \_\_lte & Comparison \tn % Row Count 7 (+ 2) % Row 6 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{\_\_startswith, \_\_istartswith, \_\_endswith, \_\_iendswith} \tn % Row Count 9 (+ 2) % Row 7 \SetRowColor{white} \_\_range & (inclusive) =(X, Y) \tn % Row Count 11 (+ 2) % Row 8 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{\_\_year, \_\_month, \_\_day, \_\_hour, \_\_minute, \_\_second} \tn % Row Count 12 (+ 1) % Row 9 \SetRowColor{white} \_\_week\_day & 1=Sun, 7=Sat \tn % Row Count 13 (+ 1) % Row 10 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{\_\_isnull} \tn % Row Count 14 (+ 1) % Row 11 \SetRowColor{white} \mymulticolumn{2}{x{5.377cm}}{\_\_regex} \tn % Row Count 15 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{x{0.84609 cm} x{4.13091 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{Related Manager Methods}} \tn % Row 0 \SetRowColor{LightBackground} add & x.ys\_set.add(y, ...) \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} \seqsplit{create} & \seqsplit{x.ys\_set.create(**kwargs)} \tn % Row Count 2 (+ 1) % Row 2 \SetRowColor{LightBackground} \seqsplit{remove*} & x.ys\_set.remove(y1, y2, ...) \tn % Row Count 4 (+ 2) % Row 3 \SetRowColor{white} \seqsplit{clear*} & x.ys\_set.clear() \tn % Row Count 5 (+ 1) % Row 4 \SetRowColor{LightBackground} & *Only available when FK(null=True) \tn % Row Count 7 (+ 2) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{x{2.28942 cm} x{2.68758 cm} } \SetRowColor{DarkBackground} \mymulticolumn{2}{x{5.377cm}}{\bf\textcolor{white}{QuerySet API}} \tn % Row 0 \SetRowColor{LightBackground} all & {\bf{X.objects.}} \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} filter & filter(**kwargs) \tn % Row Count 2 (+ 1) % Row 2 \SetRowColor{LightBackground} exclude & exclude(**kwargs) \tn % Row Count 3 (+ 1) % Row 3 \SetRowColor{white} annotate & annotate( models.Count('cost') ) \tn % Row Count 5 (+ 2) % Row 4 \SetRowColor{LightBackground} order\_by & {[}*fields\_str{]} \tn % Row Count 6 (+ 1) % Row 5 \SetRowColor{white} \mymulticolumn{2}{x{5.377cm}}{reverse} \tn % Row Count 7 (+ 1) % Row 6 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{distinct} \tn % Row Count 8 (+ 1) % Row 7 \SetRowColor{white} values & *fields\_str \tn % Row Count 9 (+ 1) % Row 8 \SetRowColor{LightBackground} values\_list & *fields\_str \tn % Row Count 10 (+ 1) % Row 9 \SetRowColor{white} date(time)?s & dates(field, kind, order) \tn % Row Count 12 (+ 2) % Row 10 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{none} \tn % Row Count 13 (+ 1) % Row 11 \SetRowColor{white} extra & extra(select=\{\}) \tn % Row Count 14 (+ 1) % Row 12 \SetRowColor{LightBackground} get (returns 1 obj) & get( **kwargs ) \tn % Row Count 16 (+ 2) % Row 13 \SetRowColor{white} create (returns 1 obj) & create( **kwargs ) \tn % Row Count 18 (+ 2) % Row 14 \SetRowColor{LightBackground} get\_or\_create (returns 1 obj) & get\_or\_create( **kwargs ) \tn % Row Count 20 (+ 2) % Row 15 \SetRowColor{white} \mymulticolumn{2}{x{5.377cm}}{count} \tn % Row Count 21 (+ 1) % Row 16 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{latest, earliest, first, last} \tn % Row Count 22 (+ 1) % Row 17 \SetRowColor{white} aggregate & aggregate( \seqsplit{models.Count('entry')} ) \tn % Row Count 24 (+ 2) % Row 18 \SetRowColor{LightBackground} \mymulticolumn{2}{x{5.377cm}}{delete} \tn % Row Count 25 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}--} \end{tabularx} \par\addvspace{1.3em} \begin{tabularx}{5.377cm}{X} \SetRowColor{DarkBackground} \mymulticolumn{1}{x{5.377cm}}{\bf\textcolor{white}{Meta Options}} \tn % Row 0 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{abstract} \tn % Row Count 1 (+ 1) % Row 1 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{app\_label} \tn % Row Count 2 (+ 1) % Row 2 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{db\_table} \tn % Row Count 3 (+ 1) % Row 3 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{db\_tablespace} \tn % Row Count 4 (+ 1) % Row 4 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{get\_latest\_by} \tn % Row Count 5 (+ 1) % Row 5 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{managed} \tn % Row Count 6 (+ 1) % Row 6 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{order\_with\_respect\_to} \tn % Row Count 7 (+ 1) % Row 7 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{ordering} \tn % Row Count 8 (+ 1) % Row 8 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{permissions} \tn % Row Count 9 (+ 1) % Row 9 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{proxy} \tn % Row Count 10 (+ 1) % Row 10 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{unique\_together} \tn % Row Count 11 (+ 1) % Row 11 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{index\_together} \tn % Row Count 12 (+ 1) % Row 12 \SetRowColor{LightBackground} \mymulticolumn{1}{x{5.377cm}}{verbose\_name} \tn % Row Count 13 (+ 1) % Row 13 \SetRowColor{white} \mymulticolumn{1}{x{5.377cm}}{verbose\_name\_plural} \tn % Row Count 14 (+ 1) \hhline{>{\arrayrulecolor{DarkBackground}}-} \end{tabularx} \par\addvspace{1.3em} % That's all folks \end{multicols*} \end{document}