Sphinx Documentation Release 1.2.3

Total Page:16

File Type:pdf, Size:1020Kb

Sphinx Documentation Release 1.2.3 Sphinx Documentation Release 1.2.3 Georg Brandl November 12, 2014 CONTENTS 1 Introduction 1 1.1 Conversion from other systems....................................1 1.2 Use with other systems........................................2 1.3 Prerequisites..............................................2 1.4 Usage..................................................2 2 First Steps with Sphinx 3 2.1 Setting up the documentation sources................................3 2.2 Defining document structure.....................................3 2.3 Adding content.............................................4 2.4 Running the build...........................................5 2.5 Documenting objects..........................................5 2.6 Basic configuration...........................................6 2.7 Autodoc.................................................6 2.8 Intersphinx...............................................7 2.9 More topics to be covered.......................................7 3 Invocation of sphinx-build9 3.1 Makefile options............................................ 11 4 Invocation of sphinx-apidoc 13 5 reStructuredText Primer 15 5.1 Paragraphs............................................... 15 5.2 Inline markup.............................................. 15 5.3 Lists and Quote-like blocks...................................... 16 5.4 Source Code............................................... 17 5.5 Tables.................................................. 18 5.6 Hyperlinks............................................... 18 5.7 Sections................................................. 18 5.8 Explicit Markup............................................ 19 5.9 Directives................................................ 19 5.10 Images.................................................. 21 5.11 Footnotes................................................ 22 5.12 Citations................................................. 22 5.13 Substitutions.............................................. 22 5.14 Comments................................................ 23 5.15 Source encoding............................................ 23 5.16 Gotchas................................................. 23 6 Sphinx Markup Constructs 25 i 6.1 The TOC tree.............................................. 25 6.2 Paragraph-level markup........................................ 28 6.3 Table-of-contents markup....................................... 30 6.4 Glossary................................................. 30 6.5 Grammar production displays.................................... 30 6.6 Showing code examples........................................ 31 6.7 Inline markup.............................................. 34 6.8 Miscellaneous markup......................................... 38 7 Sphinx Domains 43 7.1 What is a Domain?........................................... 43 7.2 Basic Markup.............................................. 43 7.3 The Python Domain.......................................... 44 7.4 The C Domain............................................. 49 7.5 The C++ Domain............................................ 50 7.6 The Standard Domain......................................... 51 7.7 The JavaScript Domain........................................ 52 7.8 The reStructuredText domain..................................... 53 7.9 More domains............................................. 54 8 Available builders 55 8.1 Serialization builder details...................................... 59 9 The build configuration file 61 9.1 General configuration......................................... 61 9.2 Project information........................................... 64 9.3 Options for internationalization................................... 65 9.4 Options for HTML output....................................... 67 9.5 Options for epub output........................................ 71 9.6 Options for LaTeX output....................................... 74 9.7 Options for text output........................................ 77 9.8 Options for manual page output................................... 77 9.9 Options for Texinfo output...................................... 78 9.10 Options for the linkcheck builder.................................. 79 9.11 Options for the XML builder..................................... 80 10 Internationalization 81 10.1 Sphinx internationalization details.................................. 82 10.2 Translating with sphinx-intl...................................... 83 10.3 Using Transifex service for team translation............................ 84 10.4 Contributing to Sphinx reference translation............................ 85 11 HTML theming support 87 11.1 Using a theme.............................................. 87 11.2 Builtin themes............................................. 90 11.3 Creating themes............................................ 93 12 Templating 95 12.1 Do I need to use Sphinx’ templates to produce HTML?...................... 95 12.2 Jinja/Sphinx Templating Primer................................... 95 12.3 Working with the builtin templates................................. 96 13 Sphinx Extensions 101 13.1 Builtin Sphinx extensions....................................... 101 13.2 Third-party extensions......................................... 124 ii 14 Developing extensions for Sphinx 125 14.1 Tutorial: Writing a simple extension................................. 125 14.2 Application API............................................ 131 14.3 Build environment API........................................ 139 14.4 Builder API............................................... 140 14.5 Docutils markup API......................................... 141 14.6 Domain API............................................... 143 14.7 Doctree node classes added by Sphinx................................ 146 15 Sphinx Web Support 149 15.1 Web Support Quick Start....................................... 149 15.2 The WebSupport Class......................................... 153 15.3 Search Adapters............................................ 156 15.4 Storage Backends............................................ 157 16 Sphinx FAQ 161 16.1 How do I.................................................. 161 16.2 Using Sphinx with............................................. 161 16.3 Epub info................................................ 162 16.4 Texinfo info............................................... 163 17 Glossary 165 18 Sphinx Developer’s Guide 167 18.1 Bug Reports and Feature Requests.................................. 167 18.2 Contributing to Sphinx........................................ 167 18.3 Coding Guide.............................................. 170 19 Changes in Sphinx 171 19.1 Release 1.2.3 (released Sep 1, 2014).................................. 171 19.2 Release 1.2.2 (released Mar 2, 2014)................................. 172 19.3 Release 1.2.1 (released Jan 19, 2014)................................. 172 19.4 Release 1.2 (released Dec 10, 2013).................................. 174 19.5 Release 1.2 beta3 (released Oct 3, 2013)............................... 175 19.6 Release 1.2 beta2 (released Sep 17, 2013)............................... 175 19.7 Release 1.2 beta1 (released Mar 31, 2013).............................. 177 19.8 Release 1.1.3 (Mar 10, 2012)...................................... 181 19.9 Release 1.1.2 (Nov 1, 2011) – 1.1.1 is a silly version number anyway!.............. 182 19.10 Release 1.1.1 (Nov 1, 2011)...................................... 182 19.11 Release 1.1 (Oct 9, 2011)........................................ 182 19.12 Release 1.0.8 (Sep 23, 2011)...................................... 184 19.13 Release 1.0.7 (Jan 15, 2011)...................................... 185 19.14 Release 1.0.6 (Jan 04, 2011)...................................... 186 19.15 Release 1.0.5 (Nov 12, 2010)...................................... 187 19.16 Release 1.0.4 (Sep 17, 2010)...................................... 187 19.17 Release 1.0.3 (Aug 23, 2010)...................................... 187 19.18 Release 1.0.2 (Aug 14, 2010)...................................... 187 19.19 Release 1.0.1 (Jul 27, 2010)....................................... 188 19.20 Release 1.0 (Jul 23, 2010)........................................ 188 19.21 Previous versions............................................ 191 20 Projects using Sphinx 193 20.1 Documentation using the default theme............................... 193 20.2 Documentation using a customized version of the default theme................ 194 20.3 Documentation using the sphinxdoc theme............................. 195 iii 20.4 Documentation using another builtin theme............................ 196 20.5 Documentation using a custom theme/integrated in a site.................... 196 20.6 Homepages and other non-documentation sites.......................... 198 20.7 Books produced using Sphinx.................................... 198 20.8 Thesis using Sphinx.......................................... 198 Python Module Index 199 Index 201 iv CHAPTER ONE INTRODUCTION This is the documentation for the Sphinx documentation builder. Sphinx is a tool that translates a set of reStructuredText1 source files into various output formats, automatically producing cross-references, indices etc. That is, if you have a directory containing a bunch of reST-formatted documents (and possibly subdirectories of docs in there as well), Sphinx can generate a nicely-organized arrangement of HTML files (in some other directory) for easy browsing
Recommended publications
  • Sagemath and Sagemathcloud
    Viviane Pons Ma^ıtrede conf´erence,Universit´eParis-Sud Orsay [email protected] { @PyViv SageMath and SageMathCloud Introduction SageMath SageMath is a free open source mathematics software I Created in 2005 by William Stein. I http://www.sagemath.org/ I Mission: Creating a viable free open source alternative to Magma, Maple, Mathematica and Matlab. Viviane Pons (U-PSud) SageMath and SageMathCloud October 19, 2016 2 / 7 SageMath Source and language I the main language of Sage is python (but there are many other source languages: cython, C, C++, fortran) I the source is distributed under the GPL licence. Viviane Pons (U-PSud) SageMath and SageMathCloud October 19, 2016 3 / 7 SageMath Sage and libraries One of the original purpose of Sage was to put together the many existent open source mathematics software programs: Atlas, GAP, GMP, Linbox, Maxima, MPFR, PARI/GP, NetworkX, NTL, Numpy/Scipy, Singular, Symmetrica,... Sage is all-inclusive: it installs all those libraries and gives you a common python-based interface to work on them. On top of it is the python / cython Sage library it-self. Viviane Pons (U-PSud) SageMath and SageMathCloud October 19, 2016 4 / 7 SageMath Sage and libraries I You can use a library explicitly: sage: n = gap(20062006) sage: type(n) <c l a s s 'sage. interfaces .gap.GapElement'> sage: n.Factors() [ 2, 17, 59, 73, 137 ] I But also, many of Sage computation are done through those libraries without necessarily telling you: sage: G = PermutationGroup([[(1,2,3),(4,5)],[(3,4)]]) sage : G . g a p () Group( [ (3,4), (1,2,3)(4,5) ] ) Viviane Pons (U-PSud) SageMath and SageMathCloud October 19, 2016 5 / 7 SageMath Development model Development model I Sage is developed by researchers for researchers: the original philosophy is to develop what you need for your research and share it with the community.
    [Show full text]
  • Automatic Generation of a 3D City Model
    UNIVERSITY OF CASTILLA-LA MANCHA ESCUELA SUPERIOR DE INFORMÁTICA COMPUTER ENGINEERING DEGREE DEGREE FINAL PROJECT Automatic generation of a 3D city model David Murcia Pacheco June, 2017 AUTOMATIC GENERATION OF A 3D CITY MODEL Escuela Superior de Informática UNIVERSITY OF CASTILLA-LA MANCHA ESCUELA SUPERIOR DE INFORMÁTICA Information Technology and Systems SPECIFIC TECHNOLOGY OF COMPUTER ENGINEERING DEGREE FINAL PROJECT Automatic generation of a 3D city model Author: David Murcia Pacheco Director: Dr. Félix Jesús Villanueva Molina June, 2017 David Murcia Pacheco Ciudad Real – Spain E-mail: [email protected] Phone No.:+34 625 922 076 c 2017 David Murcia Pacheco Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License". i TRIBUNAL: Presidente: Vocal: Secretario: FECHA DE DEFENSA: CALIFICACIÓN: PRESIDENTE VOCAL SECRETARIO Fdo.: Fdo.: Fdo.: ii Abstract HIS document collects all information related to the Degree Final Project (DFP) of Com- T puter Engineering Degree of the student David Murcia Pacheco, tutorized by Dr. Félix Jesús Villanueva Molina. This work has been developed during 2016 and 2017 in the Escuela Superior de Informática (ESI), in Ciudad Real, Spain. It is based in one of the proposed sub- jects by the faculty of this university for this year, called "Generación automática del modelo en 3D de una ciudad".
    [Show full text]
  • Tuto Documentation Release 0.1.0
    Tuto Documentation Release 0.1.0 DevOps people 2020-05-09 09H16 CONTENTS 1 Documentation news 3 1.1 Documentation news 2020........................................3 1.1.1 New features of sphinx.ext.autodoc (typing) in sphinx 2.4.0 (2020-02-09)..........3 1.1.2 Hypermodern Python Chapter 5: Documentation (2020-01-29) by https://twitter.com/cjolowicz/..................................3 1.2 Documentation news 2018........................................4 1.2.1 Pratical sphinx (2018-05-12, pycon2018)...........................4 1.2.2 Markdown Descriptions on PyPI (2018-03-16)........................4 1.2.3 Bringing interactive examples to MDN.............................5 1.3 Documentation news 2017........................................5 1.3.1 Autodoc-style extraction into Sphinx for your JS project...................5 1.4 Documentation news 2016........................................5 1.4.1 La documentation linux utilise sphinx.............................5 2 Documentation Advices 7 2.1 You are what you document (Monday, May 5, 2014)..........................8 2.2 Rédaction technique...........................................8 2.2.1 Libérez vos informations de leurs silos.............................8 2.2.2 Intégrer la documentation aux processus de développement..................8 2.3 13 Things People Hate about Your Open Source Docs.........................9 2.4 Beautiful docs.............................................. 10 2.5 Designing Great API Docs (11 Jan 2012)................................ 10 2.6 Docness.................................................
    [Show full text]
  • Chapter 4: Forges
    Chapter 4: Forges Josep M. Rib´o October 15, 2010 INDEX Chapter 4: Forges 4.1 Introduction • Repositories (forges) • Repositories of repositories 4.2 Sourceforge.net 4.3 Google code 4.4 Trac 1 4.1 Introduction INDEX 4.1 Introduction A project repository (aka a forge) is a web platform that offers project hosting and infrastructure to develop an open source project following the bazaar-model This infrastructure includes: • Version control system • Bug/issue tracker • Mail lists • Monitoring tools • Software downloading tools.... A repository of repositories (aka RoRs) is a repository that aggregates projects from other repositories or private websites extracting data and collecting various measures Usually, they are not repositories that provide infrastructure to manage the project (version control system, bug tracker...) but they provide a project index meant to search for projects that satisfy specific features 2 4.1 Introduction INDEX Repositories [BLM2008] provides a list of repositories and repositories of repositories (Table from [BLM2008]) A summary of these repositories and their features is presented in the next few slides 3 4.1 Introduction INDEX • Apache (http://www.apache.org) It stores projects developed by the Apache foundation These projects have some common features: { Collaborative, community-based development process { Open software license { Managed by a self-selected team of software experts who are the project core developers { Membership to the foundation (and the right to change the repository content) is granted only to volunteers that have contributed to the project (meritocracy) The repository offers a software catalogue with a short description of each project: { Programming languages, { Categories, { Lists, { Issue tracker { License { Proejct website { ..
    [Show full text]
  • Zentyal, El Servidor Linux Para Pymes
    Zentyal, el servidor Linux para PYMEs Olvide las tareas complejas y repetiti- Zentyal es un servidor Linux para PYMEs, la alternativa en software libre a Windows Small vas para el manejo Business Server. Basado en Ubuntu, Zentyal permite administrar todos los servicios de una red informática, tales como el acceso a Internet, la seguridad y la infraestructura de la red, los de su red informática recursos compartidos o las comunicaciones, a través de una única plataforma. Todas estas funcionalidades están estrechamente integradas, automatizando la mayoría de las tareas y ahorrando tiempo en la administración de sistemas. El código abierto está ampliamente difundido Características clave Zentyal es un software de código abierto, el cual se puede descargar libremente de Internet. Gestiona fácilmente toda la infraestructura TIC de una Actualmente, existen decenas de miles de implantaciones en todo el mundo, superando las PYME 30.000 descargas mensuales y con una comunidad de unos 2.500 colaboradores activos. Igualmente, Zentyal (antes conocido como eBox Platform) es parte integral de la distribución Acceso al correo de la empresa Ubuntu desde 2008, lo que ayuda a aumentar su difusión y credibilidad como producto tec- desde el celular, el portátil o la nológico. Su uso está extendido a prácticamente todos los países del globo, siendo Estados web independientemente de su Unidos, Alemania, España, Italia y Brasil los países que cuentan con más instalaciones. Zentyal ubicación se usa principalmente en PYMEs, pero también en otros entornos como
    [Show full text]
  • The Types, Roles, and Practices of Documentation in Data Analytics Open Source Software Libraries
    Computer Supported Cooperative Work (CSCW) https://doi.org/10.1007/s10606-018-9333-1 © The Author(s) 2018 The Types, Roles, and Practices of Documentation in Data Analytics Open Source Software Libraries A Collaborative Ethnography of Documentation Work R. Stuart Geiger1 , Nelle Varoquaux1,2 , Charlotte Mazel-Cabasse1 & Chris Holdgraf1,3 1Berkeley Institute for Data Science, University of California, Berkeley, 190 Doe Library, Berkeley, CA, 94730, USA (E-mail: [email protected]); 2Department of Statistics, Berkeley Institute for Data Science, University of California, Berkeley, Berkeley, CA, USA; 3Berkeley Institute for Data Science, Helen Wills Neuroscience Institute, University of California, Berkeley, Berkeley, CA, USA Abstract. Computational research and data analytics increasingly relies on complex ecosystems of open source software (OSS) “libraries” – curated collections of reusable code that programmers import to perform a specific task. Software documentation for these libraries is crucial in helping programmers/analysts know what libraries are available and how to use them. Yet documentation for open source software libraries is widely considered low-quality. This article is a collaboration between CSCW researchers and contributors to data analytics OSS libraries, based on ethnographic fieldwork and qualitative interviews. We examine several issues around the formats, practices, and challenges around documentation in these largely volunteer-based projects. There are many dif- ferent kinds and formats of documentation that exist around such libraries, which play a variety of educational, promotional, and organizational roles. The work behind documentation is similarly multifaceted, including writing, reviewing, maintaining, and organizing documentation. Different aspects of documentation work require contributors to have different sets of skills and overcome various social and technical barriers.
    [Show full text]
  • Vmpro 3.2 Open Source Licenses
    Quantum vmPRO 3.2 Open Source Licenses This document presents the open source software components used in Quantum® vmPRO™ 3.2. For information on obtaining the open source code, contact Quantum Support. Abstract This document lists the open source components used in the vmPRO product along with their licenses. 6-67728-03 Rev A, August 2014 *6-67728-02 A* Quantum vmPRO 3.2 Open Source License Agreement 6-67728-03 Rev A August 2014 Standard RPMs in the CentOS OS Package Version Build URL License ConsoleKit 0.4.1 3.el6 http://www.freedesktop.org/wiki/Software/ GPLv2+ ConsoleKit ConsoleKit- 0.4.1 3.el6 http://www.freedesktop.org/wiki/Software/ MIT libs ConsoleKit MAKEDEV 3.24 6.el6 http://www.lanana.org/docs/device-list/ GPLv2 MariaDB- 10.0.3 1 http://mariadb.org GPL compat MariaDB- 10.0.3 1 (none) GPL compat-pkg QuantumOS 2.8.0 2607 (none) Proprietary TPlugin acl 2.2.49 6.el6 http://acl.bestbits.at/ GPLv2+ aic94xx- 30 2.el6 http://www.adaptec.com/en-US/speed/scsi/ Redistributable, no firmware linux/aic94xx-seq-30-1_tar_gz.htm modification permitted atmel- 1.3 7.el6 http://at76c503a.berlios.de/ Redistributable, no firmware modification permitted attr 2.4.44 7.el6 http://acl.bestbits.at/ GPLv2+ audit-libs 2.2 2.el6 http://people.redhat.com/sgrubb/audit/ LGPLv2+ authconfig 6.1.12 13.el6 https://fedorahosted.org/authconfig GPLv2+ avahi-libs 0.6.25 12.el6 http://avahi.org LGPLv2 Made in the USA. Quantum Corporation provides this publication “as is” without warranty of any kind, either express or implied, including but not limited to the implied warranties of merchantability or fitness for a particular purpose.
    [Show full text]
  • An Introduction to Numpy and Scipy
    An introduction to Numpy and Scipy Table of contents Table of contents ............................................................................................................................ 1 Overview ......................................................................................................................................... 2 Installation ...................................................................................................................................... 2 Other resources .............................................................................................................................. 2 Importing the NumPy module ........................................................................................................ 2 Arrays .............................................................................................................................................. 3 Other ways to create arrays............................................................................................................ 7 Array mathematics .......................................................................................................................... 8 Array iteration ............................................................................................................................... 10 Basic array operations .................................................................................................................. 11 Comparison operators and value testing ....................................................................................
    [Show full text]
  • Manticore Search Documentation Release 3.0.2
    Manticore Search Documentation Release 3.0.2 The Manticore Search team Apr 01, 2021 Manticore Documentation 1 Introduction 1 2 Gettting Started 5 2.1 Getting started using Docker container.................................5 2.2 Getting Started using official packages................................. 10 2.3 Migrating from Manticore or Sphinx Search 2.x............................ 15 2.4 A guide on configuration file....................................... 17 2.5 A guide on connectivity......................................... 19 2.6 A guide on indexes............................................ 21 2.7 A guide on searching........................................... 24 3 Installation 31 3.1 Installing Manticore packages on Debian and Ubuntu.......................... 31 3.2 Installing Manticore packages on RedHat and CentOS......................... 32 3.3 Installing Manticore on Windows.................................... 33 3.4 Upgrading from Sphinx Search..................................... 34 3.5 Running Manticore Search in a Docker Container............................ 34 3.6 Compiling Manticore from source.................................... 35 3.7 Quick Manticore usage tour....................................... 38 4 Indexing 43 4.1 Indexes.................................................. 43 4.2 Data Types................................................ 47 4.3 Full-text fields.............................................. 49 4.4 Attributes................................................. 49 4.5 MVA (multi-valued attributes).....................................
    [Show full text]
  • Advanced Search Capabilities with Mysql and Sphinx
    Advanced search capabilities with MySQL and Sphinx Vladimir Fedorkov, Blackbird Andrew Aksyonoff, Sphinx Percona Live MySQL UC, 2014 Knock knock who’s there • Vladimir – Used Sphinx in production since 2006 – Performance geek – Blog http://astellar.com, twitter @vfedorkov – Works for Blackbird • Andrew – Created Sphinx, http://sphinxsearch.com – Just some random guy Search is important • This is 2014, Google spoiled everyone! • Search needs to exist • Search needs to be fast • Search needs to be relevant • Today, we aim to show you how to start – With Sphinx, obviously Available solutions • Most databases have integrated FT engines – MySQL (My and Inno), Postgres, MS SQL, Oracle… • Standalone solutions – Sphinx – Lucene / Solr – Lucene / ElasticSearch • Hosted services – IndexDen, SearchBox, Flying Sphinx, WebSolr, … Why Sphinx? • Built-in DB search sucks • Sphinx works great with DBs and MySQL • Sphinx talks SQL => zero learning curive • Fast, scalable, relevant, and other buzzwords :P • You probably heard about Lucene anyway • NEED MOAR DIVERSITY What Sphinx is not • Not a plugin to MySQL • Does not require MySQL • Not SQL-based (but we talk SQL) – Non-SQL APIs are available • Not a complete database replacement – Yet? – Ever! OLAP vs OLTP vs Column vs FTS vs Webscale Quick overview • Sphinx = standalone, open-source search server • Supports Real-time indexes • Fast – 10+ MB/sec/core indexing, 700+ qps/core searching – And counting! • Scalable – Can do a lot even on 1 box – Lets you aggregate search results from N boxes – Auto-sharding,
    [Show full text]
  • Sphinxql Query Builder Release 1.0.0
    SphinxQL Query Builder Release 1.0.0 Oct 12, 2018 Contents 1 Introduction 1 1.1 Compatiblity...............................................1 2 CHANGELOG 3 2.1 What’s New in 1.0.0...........................................3 3 Configuration 5 3.1 Obtaining a Connection.........................................5 3.2 Connection Parameters..........................................5 4 SphinxQL Query Builder 7 4.1 Creating a Query Builder Instance....................................7 4.2 Building a Query.............................................7 4.3 COMPILE................................................ 10 4.4 EXECUTE................................................ 10 5 Multi-Query Builder 13 6 Facets 15 7 Contribute 17 7.1 Pull Requests............................................... 17 7.2 Coding Style............................................... 17 7.3 Testing.................................................. 17 7.4 Issue Tracker............................................... 17 i ii CHAPTER 1 Introduction The SphinxQL Query Builder provides a simple abstraction and access layer which allows developers to generate SphinxQL statements which can be used to query an instance of the Sphinx search engine for results. 1.1 Compatiblity SphinxQL Query Builder is tested against the following environments: • PHP 5.6 and later • Sphinx (Stable) • Sphinx (Development) Note: It is recommended that you always use the latest stable version of Sphinx with the query builder. 1 SphinxQL Query Builder, Release 1.0.0 2 Chapter 1. Introduction CHAPTER 2 CHANGELOG 2.1 What’s New in 1.0.0 3 SphinxQL Query Builder, Release 1.0.0 4 Chapter 2. CHANGELOG CHAPTER 3 Configuration 3.1 Obtaining a Connection You can obtain a SphinxQL Connection with the Foolz\SphinxQL\Drivers\Mysqli\Connection class. <?php use Foolz\SphinxQL\Drivers\Mysqli\Connection; $conn= new Connection(); $conn->setparams(array('host' => '127.0.0.1', 'port' => 9306)); Warning: The existing PDO driver written is considered experimental as the behaviour changes between certain PHP releases.
    [Show full text]
  • Oracle Spatial 11G Release 2 New Features Deep Dive Siva Ravada Director of Development, Oracle Spatial
    Title of Presentation Oracle Spatial 11g Release 2 New Features Deep Dive Siva Ravada Director of Development, Oracle Spatial Michael Smith US Army Corps of Engineers Agenda • Introduction to Oracle Spatial <Insert Picture Here> • Spatial Engine • SQL Developer • GeoRaster • Network Data Model • Moving Objects • 3D Support Oracle Spatial Features – Oracle Locator: Feature of Oracle Database XE, SE, EE – Oracle Spatial: Priced option to HTTP Oracle Database EE Fusion Middleware – MapViewer*: Java application and map rendering feature of Fusion MapViewer Middleware – Bundled Map Content: Major roads, JDBC administrative boundaries (city, county, state, country) - worldwide Oracle Database coverage from Navteq Oracle Locator Oracle Spatial Bundled Map Content Supports all Geospatial Data types Polygons (admin, sales territories, Locations high risk zones) Networks (points of interest) (roads, utilities) Data Imagery 3D data type (satellite imagery) Topology (city models) (data provider) LIDAR Data Type TIN Data Type Open Platform for Leading Applications and Tools MapInfo Leica ADE Bentley Manifold Oracle Spatial 11g Enabled Applications Scrollable, Interactive Maps Spatial Web Services 3D, Point Clouds, and LIDAR Geocoding & Routing Oracle BI Dashboards Raster Imagery Spatial Engine Spatial on Exadata • We achieve performance improvements based on the exploitation of the processing power, bandwidth, and parallelism of the Exadata machine • Parallel query and partitioning help improve Spatial performance • All the row level functions are also parallel enabled to take advantage of parallel query • Speedups of up to 40 times (compared to a 1-core CPU box) for the typical SDO_ANYINTERACT spatial query • Spatial predicates are not currently pushed into the Exadata storage nodes 9 Spatial Index Parallel Creation on Exadata • Build a Local Spatial Index on Partitioned Table: each slave can build a different index partition in parallel.
    [Show full text]