0-intro.tpl.go

//** This file was code generated by GoT. DO NOT EDIT. ***

package orm

import (
	"context"
	"io"
)

// DrawTemplate draws the content of the matching control's template file.
func (ctrl *IntroPanel) DrawTemplate(ctx context.Context, _w io.Writer) (err error) {

	if _, err = io.WriteString(_w, `<h1>Introduction to the ORM</h1>
<p>
The Object-Relational Model, or ORM, is a code-generated package of structures and functions that make it possible
to access a variety of different kinds of databases using a common interface. The structures let you easily access
objects and member variables of objects, and also traverse relationships between objects.
</p>
<h2>Terminology</h2>
`); err != nil {
		return
	}

	if _, err = io.WriteString(_w, `<p>
`); err != nil {
		return
	}

	if _, err = io.WriteString(_w, `Different databases refer to data objects using different words, but the concepts are the same. For example,
in a SQL database a collection of objects corresponds to a &#34;table&#34; and a member variable in an object corresponds to a &#34;field&#34;.
Each object in a table has a member variable which contains a unique key to identify that object, called the &#34;primary key&#34;.
Relationships between two tables are defined using a &#34;foreign key&#34;, which is essentially just a member variable in one
object that contains a copy of the primary key of a different object.
`); err != nil {
		return
	}

	if _, err = io.WriteString(_w, `</p>
<p>
`); err != nil {
		return
	}

	if _, err = io.WriteString(_w, `For example, if a &#34;project&#34; object wanted easy access to the &#34;person&#34; object that is the manager of the project,
the &#34;project&#34; object could have a member called &#34;manager_id&#34;, which is the primary key of the &#34;person&#34; object
that contains information on the project&#39;s manager. Note that this sets up a one-to-many relationship, because
the project points to only one manager, but a manager might be managing multiple projects, and so will have multiple projects
pointing back to the manager.

This tutorial will teach you how to set up database relationships, and traverse them to create and retrieve the data you want.

If you have not yet set up the example database, do that now using the steps below.
`); err != nil {
		return
	}

	if _, err = io.WriteString(_w, `</p>
<h2>Naming Conventions</h2>
<p>
When creating your database, name your tables and fields using snake_case, which means use all lower-case letters and
separate words with underscores. The reason for this is that some databases are not case-sensitive, and so Goradd has
adopted this convention to provide the maximum compatibility between different kinds of databases.
</p>
<p>
The Goradd ORM will convert snake_case names in the database to CamelCase names in Go code, meaning each name will capitalize the
start of each word.
</p>
<p>
`); err != nil {
		return
	}

	if _, err = io.WriteString(_w, `For example, a field named &#34;team_member&#34; in the database will become &#34;TeamMember&#34; in Go.
`); err != nil {
		return
	}

	if _, err = io.WriteString(_w, `</p>

`); err != nil {
		return
	}

	return
}