Mercurial > hg > MonetDB-extend
changeset 11:bbc6dff47679
Added a top-level README and Makefile.
author | Sjoerd Mullender <sjoerd@acm.org> |
---|---|
date | Thu, 07 Dec 2017 16:33:32 +0100 (2017-12-07) |
parents | 2047fa5d7dd7 |
children | 99b60d4e57ba |
files | Makefile README.rst |
diffstat | 2 files changed, 69 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/Makefile Thu Dec 07 16:33:32 2017 +0100 @@ -0,0 +1,18 @@ +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. +# +# Copyright 2008-2015 MonetDB B.V. + +all: + +doc: README.html README.pdf + +README.html: README.rst + rst2html -d README.rst > README.html + +README.pdf: README.rst + rst2pdf README.rst + +clean: + rm -f README.html README.pdf
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/README.rst Thu Dec 07 16:33:32 2017 +0100 @@ -0,0 +1,51 @@ +.. This Source Code Form is subject to the terms of the Mozilla Public +.. License, v. 2.0. If a copy of the MPL was not distributed with this +.. file, You can obtain one at http://mozilla.org/MPL/2.0/. +.. +.. Copyright 2016 MonetDB B.V. + +.. This document is written in reStructuredText (see + http://docutils.sourceforge.net/ for more information). + Use ``rst2html.py`` to convert this file to HTML. + +=================================== +Implementing User-Defined Functions +=================================== + +:Author: Sjoerd Mullender +:Organization: CWI, MonetDB B.V. +:Abstract: In this short tutorial we describe how to create a simple + UDF for MonetDB/SQL. + +Introduction +------------ + +In this directory there are a number of tutorials for creating +user-defined functions. It is recommended to go through these +tutorials in the order presented here, since they will go from simple +to more complicated. + +Setting Up +---------- + +These tutorials work completely outside the source of the MonetDB +suite. You do not need to copy the source of MonetDB, and you do not +need to recompile the MonetDB sources. You do need to install some +extra packages that are not normally installed. + +On Fedora and RedHat-based systems you need to install the packages +``MonetDB5-server-devel``, ``MonetDB-devel``, and +``MonetDB-stream-devel``. On Debian and Ubuntu you need to install +the packages ``monetdb5-server-dev``, ``libmonetdb-dev``, and +``libmonetdb-stream-dev``. + +Tutorials +--------- + +reverse +....... + +Start with the tutorial in the ``reverse`` subdirectory. In this +tutorial you will create a simple user-defined function (UDF) that +takes one (string) value as input and produces one (string) value as +output.